Webhooks
Cadastrar, editar, testar, trocar o segredo e ver as entregas dos webhooks.
Endpoints#
- GETListar webhooks
/webhooks - POSTCriar webhook
/webhooks - GETVer um webhook
/webhooks/{id} - PATCHAtualizar webhook
/webhooks/{id} - DELApagar webhook
/webhooks/{id} - POSTTrocar o segredo
/webhooks/{id}/rotacionar - POSTMandar um evento de teste
/webhooks/{id}/testar - GETHistórico de entregas
/webhooks/{id}/entregas - POSTReenviar uma entrega
/webhooks/entregas/{id}/reenviar
Códigos de erro#
Além dos gerais (chave, limite, JSON), estes podem vir em erro.codigo nas rotas daqui. Todos estão em Erros.
| codigo | O que significa |
|---|---|
| webhook_inexistente | Webhook não encontrado. |
| entrega_inexistente | Entrega não encontrada. |
| webhook_desativado | Este webhook está desativado. Reative com PATCH {"ativo": true}. |
| entrega_em_andamento | Esta entrega ainda está em andamento. |
| entrega_ja_despachada | Esta entrega já saiu uma vez e não é repetida (entrega única, sem duplicar). Só entregas que nunca saíram podem ser reenviadas. |
| url_invalida | URL inválida: use https://, porta 443 e um nome de domínio público. |
| destino_bloqueado | Esse endereço aponta para uma rede interna ou reservada. Use um endereço público. |
| dns_falhou | Não conseguimos resolver esse domínio. Confira o endereço. |
| eventos_invalidos | Algum evento não existe. Veja a lista na documentação. |
| limite_de_webhooks | Limite de 10 webhooks por organização. |
| nome_invalido | Nome deve ter de 1 a 60 caracteres. |
| graca_invalida | horas deve ser de 0 a 168. |