Testar o webhook
POST /webhooks/{id}/ping
Entrega um evento sintético webhook.ping direto na URL do webhook, usando a credencial dele,
de forma síncrona e fora da fila de eventos. Use para validar conectividade e credenciais sem
esperar um evento de negócio real. Sem body.
Sucesso — 200 OK
{
"success": false,
"statusCode": null,
"failureReason": "UNREACHABLE",
"errorDetail": "UnknownHostException: partner.example.com"
}| Campo | Tipo | Descrição |
|---|---|---|
success | boolean | true se o seu endpoint respondeu 2xx |
statusCode | integer | null | Status HTTP que o seu endpoint respondeu, quando respondeu |
failureReason | string | null | HTTP_ERROR, UNREACHABLE ou AUTH_FAILED. null em caso de sucesso |
errorDetail | string | null | Erro concreto: corpo da resposta do seu endpoint, erro de conexão ou erro na troca de token |
failureReason | Significado |
|---|---|
HTTP_ERROR | O endpoint respondeu com status não-2xx — ver statusCode |
UNREACHABLE | Sem resposta HTTP: DNS, conexão recusada, TLS ou timeout |
AUTH_FAILED | A credencial não pôde ser usada (ex.: o tokenUrl rejeitou clientId/clientSecret) |
Verifique
success, não o status HTTP. A chamada responde200sempre que o webhook
existe e pertence a você — a falha do seu endpoint é o payload, não um erro desta API.
Um ping bem-sucedido também reativa um webhookSUSPENDED.
Erros mapeados
| HTTP | code | Quando ocorre |
|---|---|---|
| 404 | WEBHOOK_NOT_FOUND | Webhook não existe ou pertence a outro parceiro |
| 500 | WEBHOOK_INTEGRATION_FAILURE | Falha de comunicação interna — repetir com backoff |
Updated about 1 hour ago
