List workspace webhooks
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 { "webhooks": [ … ], "events": [ … ] }: every phone-line webhook of your workspace, oldest first, and the catalogue of events you can subscribe to. The signing secret is never returned here — only once, by POST /v1/workspace/webhooks.
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.
curl --request GET \
--url https://pilotstatus.com.br/v1/workspace/webhooks \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/workspace/webhooks"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/workspace/webhooks', 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",
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"
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))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/workspace/webhooks")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/workspace/webhooks")
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{
"webhooks": [
{
"id": "cmh1w8b2k0001wh8example3d",
"name": "hooks.example.com",
"url": "https://hooks.example.com/pilot/phone-lines",
"events": [
"*"
],
"active": true,
"lastDeliveryAt": "2026-10-27T14:11:51.000Z",
"lastStatusCode": 200,
"createdAt": "2026-10-27T13:58:02.000Z"
}
],
"events": [
"phone_line.purchased",
"phone_line.audio_received",
"phone_line.code_received",
"phone_line.code_failed",
"phone_line.renewed",
"phone_line.payment_failed",
"phone_line.suspended",
"phone_line.returned",
"phone_line.canceled",
"phone_line.verification_updated",
"wallet.topup_paid"
]
}Authorizations
Your ps_ API key
Headers
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.
Response
The webhooks and the event catalogue
Show child attributes
Show child attributes
Every phone-line event name. "*" is not in the list but is accepted in events.
[
"phone_line.purchased",
"phone_line.audio_received",
"phone_line.code_received",
"phone_line.code_failed",
"phone_line.renewed",
"phone_line.payment_failed",
"phone_line.suspended",
"phone_line.returned",
"phone_line.canceled",
"phone_line.verification_updated"
]
Was this page helpful?
curl --request GET \
--url https://pilotstatus.com.br/v1/workspace/webhooks \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/workspace/webhooks"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/workspace/webhooks', 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",
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"
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))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/workspace/webhooks")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/workspace/webhooks")
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{
"webhooks": [
{
"id": "cmh1w8b2k0001wh8example3d",
"name": "hooks.example.com",
"url": "https://hooks.example.com/pilot/phone-lines",
"events": [
"*"
],
"active": true,
"lastDeliveryAt": "2026-10-27T14:11:51.000Z",
"lastStatusCode": 200,
"createdAt": "2026-10-27T13:58:02.000Z"
}
],
"events": [
"phone_line.purchased",
"phone_line.audio_received",
"phone_line.code_received",
"phone_line.code_failed",
"phone_line.renewed",
"phone_line.payment_failed",
"phone_line.suspended",
"phone_line.returned",
"phone_line.canceled",
"phone_line.verification_updated",
"wallet.topup_paid"
]
}