Reenviar eventos
Este endpoint solicita o reenvio (replay) de um evento aos endpoints elegíveis para aquele tipo de evento. É útil quando ocorrem falhas na entrega original ou quando você precisa ressincronizar sistem
Visão Geral
Este endpoint solicita o reenvio (replay) de um evento aos endpoints elegíveis para aquele tipo de evento. É útil quando ocorrem falhas na entrega original ou quando você precisa ressincronizar sistemas externos.
Descrição
Ao receber o eventId, a API localiza o evento, coleta todos os endpoints (ativos, no mesmo ambiente) inscritos naquele tipo e dispara uma nova entrega (replay forçado) para cada um. Para reentregar a um endpoint específico, use o Reenviar Dispatch.
Requisição
POST /v1/webhooks/events/{eventId}/resendCabeçalho: SelectKey: sk_live_... (ou sk_test_...). Escopo necessário: webhooks:update. Não há corpo de requisição.
Parâmetros de Caminho
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
eventId | string | Sim | ID do evento a reenviar (wbh_*) | wbh_01hqzvabc |
Resposta
Aceito (202 Accepted)
{
"accepted": true,
"id": "wbh_01hqzvabc"
}Atributos da Resposta
| Atributo | Tipo | Descrição |
|---|---|---|
accepted | boolean | Sempre true quando o reenvio foi disparado |
id | string | ID do evento reenviado (wbh_*) |
Exemplo de Uso
POST /v1/webhooks/events/wbh_01hqzvabc/resendConsiderações
-
Processamento Assíncrono: a resposta
202indica que o reenvio foi disparado; o resultado de cada entrega aparece nos Dispatches. -
Idempotência: garanta que seu endpoint processe o mesmo evento múltiplas vezes sem efeitos colaterais. Deduplique pelo
iddo evento. -
Replay forçado: o reenvio dispara a entrega mesmo que já tenha havido sucesso anterior naquele endpoint.
-
Escopo de ambiente: o reenvio alcança apenas endpoints do mesmo ambiente (sandbox/live) da sua chave de API.
Códigos de Erro
| Código HTTP | Descrição |
|---|---|
| 401 | Não autorizado (SelectKey ausente/inválida) |
| 403 | Sem o escopo webhooks:update |
| 404 | Evento não encontrado (webhookEventNotFound) |
| 500 | Erro interno do servidor |
Casos de Uso Comuns
- Recuperação de Falhas: reenviar eventos que falharam por problemas temporários no endpoint.
- Ressincronização: garantir que sistemas externos receberam todos os eventos após uma manutenção.
- Diagnóstico: identificar se as falhas de entrega são persistentes ou temporárias.
How is this guide?