Webhooks
Um webhook recebe por POST cada evento que combina com os filtros dele, assinado com HMAC-SHA256. Entregas ficam numa tabela (outbox), sobrevivem a restarts e são repetidas por até 24 horas; depois vão para a dead-letter, de onde podem ser reenviadas. Com token admin o webhook pode ser global (todas as instâncias) ou de uma instância; com token de instância é sempre da própria instância.
Payloads de cada evento estão no catálogo de eventos e a verificação da assinatura em Verificar assinatura.
Conceito: leia antes de integrar.
Operações
| Operação | Rota | Token |
|---|---|---|
| Listar webhooks | GET /v1/webhooks | token da instância ou admin |
| Criar webhook | POST /v1/webhooks | token da instância ou admin |
| Consultar webhook | GET /v1/webhooks/{wid} | token da instância ou admin |
| Atualizar webhook | PATCH /v1/webhooks/{wid} | token da instância ou admin |
| Apagar webhook | DELETE /v1/webhooks/{wid} | token da instância ou admin |
| Listar entregas | GET /v1/webhooks/{wid}/deliveries | token da instância ou admin |
| Reenviar entrega | POST /v1/webhooks/{wid}/deliveries/{delivery_id}/retry | token da instância ou admin |
Gerado de openapi.yaml. Convenções gerais na visão geral e todos os códigos em Erros.