Workspace

Listar entregas do webhook do workspace

Webhooks do workspace — o mesmo cadastro de /v1/phone-lines/webhooks (mesmas linhas, segredo plwh_, assinatura, retentativas e entregas), com mais eventos: todos os phone_line.* e mais wallet.topup_paid (uma recarga da carteira foi creditada). "*" significa só os eventos das linhas: wallet.topup_paid é opcional, liste-o pelo nome (por exemplo ["*", "wallet.topup_paid"]). Esta superfície lista todos os webhooks do workspace. Chave com escopo de tenant (ou chave de conta com x-workspace-id); Proprietário ou Admin (phone_lines:webhooks) com credencial de usuário.

Retorna { "deliveries": [ … ] }: as entregas mais recentes do webhook, da mais nova para a mais antiga, com a situação e o resultado — nunca o payload (um phone_line.code_received traz o código de ativação; leia uma entrega completa com GET …/deliveries/{deliveryId}). Um webhook de outro workspace responde 404 WEBHOOK_NOT_FOUND, nunca uma lista vazia.

Permissões: com um token OAuth / MCP, o usuário precisa ser Proprietário ou Administrador (phone_lines:webhooks) — caso contrário, 403 PERMISSION_DENIED.

Todo endpoint /v1/phone-lines aceita só uma chave com escopo de tenant: os webhooks das linhas pertencem ao workspace, não a um número de WhatsApp, então uma chave com escopo de número (ou uma concessão OAuth por número) recebe 403 NUMBER_SCOPE_NOT_ALLOWED antes de qualquer verificação de papel. Um 403 PERMISSION_DENIED / WORKSPACE_MEMBERSHIP_REQUIRED é enviado com Cache-Control: no-store.

Estes são os webhooks das linhas — um cadastro separado de /v1/webhooks: recebem só eventos phone_line.*, e um webhook de número nunca recebe um deles.

Requer uma chave com escopo de tenant.

GET

workspace

webhooks

{id}

deliveries

Listar as entregas de um webhook

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"
    }
  ]
}

Autorizações

x-api-key

string

header

obrigatório

Sua chave de API ps_

Cabeçalhos

x-workspace-id

string

Só com chave de conta (ps_account_): o workspace em que agir, obtido em GET /v1/workspaces. Sem ele, uma chave de conta recebe 400 WORKSPACE_ID_REQUIRED.

Parâmetros de caminho

string

obrigatório

O id do webhook (de GET /v1/phone-lines/webhooks ou da resposta da criação).

Parâmetros de consulta

limit

string

De 1 a 200 (padrão 50). Qualquer outro valor (0, 201, um número decimal, texto, vazio) → 400 INVALID_LIMIT. (integer (1–200))

Resposta

As entregas mais recentes

deliveries

object[]

Show child attributes

Listar as entregas de um webhook

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"
    }
  ]
}