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"
}
CampoTipoDescrição
successbooleantrue se o seu endpoint respondeu 2xx
statusCodeinteger | nullStatus HTTP que o seu endpoint respondeu, quando respondeu
failureReasonstring | nullHTTP_ERROR, UNREACHABLE ou AUTH_FAILED. null em caso de sucesso
errorDetailstring | nullErro concreto: corpo da resposta do seu endpoint, erro de conexão ou erro na troca de token
failureReasonSignificado
HTTP_ERRORO endpoint respondeu com status não-2xx — ver statusCode
UNREACHABLESem resposta HTTP: DNS, conexão recusada, TLS ou timeout
AUTH_FAILEDA credencial não pôde ser usada (ex.: o tokenUrl rejeitou clientId/clientSecret)

Verifique success, não o status HTTP. A chamada responde 200 sempre 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 webhook SUSPENDED.

Erros mapeados

HTTPcodeQuando ocorre
404WEBHOOK_NOT_FOUNDWebhook não existe ou pertence a outro parceiro
500WEBHOOK_INTEGRATION_FAILUREFalha de comunicação interna — repetir com backoff