Saltar para a documentação
API

Eventos e estatísticas dos webhooks

Os eventos que um endpoint pode subscrever e como correram as entregas.

GET/webhooks/events

Executa qualquer uma das 2 chamadas no seu espaço de trabalho.

Eventos

GET /webhooks/events lista cada evento que um endpoint pode indicar em eventTypes, cada um com uma frase a dizer quando dispara, e os limites a que um endpoint está sujeito: maxEndpoints para o espaço de trabalho, que o seu plano decide, e maxAddresses e maxDomains para uma lista de permissões. Precisa de webhooks:read.

GET /webhooks/events
{  "object": "webhook_catalogue",  "events": [    { "id": "email.sent", "label": "A message left OpenEmail." },    { "id": "email.bounced", "label": "A message bounced." }  ],  "maxEndpoints": 10,  "maxAddresses": 50,  "maxDomains": 20}

Um endpoint que não indica nenhum evento recebe todos os eventos de email exceto email.replied, por isso email.replied e as outras famílias só chegam a um endpoint que os peça pelo nome.

Estatísticas

GET /webhooks/stats lê como correram as entregas num período, o separador Análises da página Webhooks: as tentativas, as entregues e as falhadas, o tempo mediano que um recetor levou a responder, uma série de intervalos, os eventos enviados e os códigos de resposta recebidos. Precisa de webhooks:read. endpointIds restringe-o a alguns endpoints, since e until definem o período, 30 dias por omissão, e grain e offsetMinutes dão forma à série. Cada vez que se tenta entregar um evento conta como uma tentativa.

GET /webhooks/stats?grain=day
{  "object": "webhook_stats",  "since": "2026-09-02T00:00:00.000Z",  "until": "2026-10-02T00:00:00.000Z",  "grain": "day",  "endpointIds": [],  "totals": { "attempts": 1280, "delivered": 1266, "failed": 14, "medianDurationMs": 212 },  "buckets": [{ "bucket": "2026-09-28", "delivered": 44, "failed": 1 }],  "events": [{ "id": "email.delivered", "count": 702 }],  "codes": [{ "id": "200", "count": 1266 }, { "id": "503", "count": 14 }]}

Referência