Visão geral

Um dispatch (entrega) é uma tentativa de entrega de um evento de webhook a um endpoint específico. Enquanto um evento(/docs/guide/webhook-events/overview) representa o fato ocorrido na sua conta (ex.:

Visão Geral

Um dispatch (entrega) é uma tentativa de entrega de um evento de webhook a um endpoint específico. Enquanto um evento representa o fato ocorrido na sua conta (ex.: transaction.approved), cada evento pode gerar um dispatch por endpoint ativo elegível para aquele tipo de evento. Os dispatches registram o resultado de cada tentativa: status, número de tentativas e código HTTP retornado pelo seu servidor.

Use os endpoints de Dispatches para auditar entregas, diagnosticar falhas por endpoint e reenviar uma entrega específica que não foi confirmada.

Relação entre Eventos e Dispatches

webhookEvents (1) ──< (N) webhookDispatches
   evento "transaction.approved"
   ├── dispatch → endpoint A   (status: success, HTTP 200)
   └── dispatch → endpoint B   (status: failed,  HTTP 500)

Um evento com vários endpoints elegíveis produz vários dispatches.
A listagem de eventos já traz os dispatches aninhados em cada item (dispatches[]). Os endpoints abaixo expõem os dispatches como recurso de primeira classe, com filtros próprios e reenvio individual.

Ciclo de Vida (status)

Status	Significado
`pending`	Entrega ainda não tentada / enfileirada.
`retrying`	Entrega falhou e está em política de retentativa (backoff).
`success`	Entrega confirmada (o endpoint respondeu com `2xx`).
`failed`	Entrega falhou após esgotar as tentativas.
`canceled`	Entrega cancelada.

Operações

Método	Caminho	Escopo	Descrição	Guia
GET	`/v1/webhooks/dispatches`	`webhooks:read`	Lista paginada de tentativas de entrega, com filtros	Listar
POST	`/v1/webhooks/dispatches/{dispatchId}/redispatch`	`webhooks:update`	Reenvia (redeliver) uma entrega ao endpoint específico	Reenviar

Não existe um endpoint dedicado de "analytics" de dispatches. Para métricas de entrega (taxa de sucesso/falha por período), use a listagem com filtros de status, daterange* e onlyErrored. Veja Analytics.

Identificadores

Os dispatches usam o prefixo de ID wdi_ (ex.: wdi_01hqzvabc). Trate-o como string opaca. Os IDs relacionados seguem o mesmo padrão: evento wbh_, endpoint wbe_.