Workspace

List workspace webhook deliveries

Workspace webhooks — the same registry as /v1/phone-lines/webhooks (same rows, plwh_ secret, signature, retries and deliveries), with a wider event set: every phone_line.* event plus wallet.topup_paid (a wallet top-up was credited). "*" means every phone-line event only: wallet.topup_paid is opt-in, list it by name (for example ["*", "wallet.topup_paid"]). This surface lists every webhook of the workspace. Tenant-scoped key (or account key with x-workspace-id); Owner or Admin (phone_lines:webhooks) with a user credential.

Returns { "deliveries": [ … ] }: the webhook’s latest deliveries, newest first, with their status and outcome — never their payload (a phone_line.code_received carries the activation code; read one delivery in full with GET …/deliveries/{deliveryId}). A webhook of another workspace answers 404 WEBHOOK_NOT_FOUND, never an empty list.

Permissions: with an OAuth / MCP token, the user must be an Owner or Admin (phone_lines:webhooks) — 403 PERMISSION_DENIED otherwise.

Every /v1/phone-lines endpoint takes a tenant-scoped key only: phone-line webhooks belong to the workspace, not to a WhatsApp number, so a number-scoped key (or a per-number OAuth grant) gets 403 NUMBER_SCOPE_NOT_ALLOWED before any role is looked at. A 403 PERMISSION_DENIED / WORKSPACE_MEMBERSHIP_REQUIRED is sent with Cache-Control: no-store.

These are the phone-line webhooks — a registry separate from /v1/webhooks: they receive only phone_line.* events, and a number webhook never receives one.

Requires a tenant-scoped key.

GET

workspace

webhooks

{id}

deliveries

List a webhook's deliveries

curl --request GET \
  --url https://pilotstatus.com.br/v1/workspace/webhooks/{id}/deliveries \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/workspace/webhooks/{id}/deliveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pilotstatus.com.br/v1/workspace/webhooks/{id}/deliveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://pilotstatus.com.br/v1/workspace/webhooks/{id}/deliveries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/workspace/webhooks/{id}/deliveries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "deliveries": [
    {
      "id": "cmh1w9c4m0002dl8example5f",
      "event": "phone_line.code_received",
      "status": "DELIVERED",
      "attempts": 1,
      "responseStatus": 200,
      "lastError": null,
      "createdAt": "2026-10-27T14:11:51.000Z",
      "deliveredAt": "2026-10-27T14:11:52.000Z"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Headers

x-workspace-id

string

Only with an account key (ps_account_): the workspace to act on, from GET /v1/workspaces. Without it an account key gets 400 WORKSPACE_ID_REQUIRED.

Path Parameters

string

required

The webhook's id (from GET /v1/phone-lines/webhooks or the create response).

Query Parameters

limit

string

From 1 to 200 (default 50). Any other value (0, 201, a decimal, text, empty) → 400 INVALID_LIMIT. (integer (1–200))

Response

The latest deliveries

deliveries

object[]

Show child attributes

List a webhook's deliveries

curl --request GET \
  --url https://pilotstatus.com.br/v1/workspace/webhooks/{id}/deliveries \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/workspace/webhooks/{id}/deliveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pilotstatus.com.br/v1/workspace/webhooks/{id}/deliveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://pilotstatus.com.br/v1/workspace/webhooks/{id}/deliveries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/workspace/webhooks/{id}/deliveries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "deliveries": [
    {
      "id": "cmh1w9c4m0002dl8example5f",
      "event": "phone_line.code_received",
      "status": "DELIVERED",
      "attempts": 1,
      "responseStatus": 200,
      "lastError": null,
      "createdAt": "2026-10-27T14:11:51.000Z",
      "deliveredAt": "2026-10-27T14:11:52.000Z"
    }
  ]
}