Referência / Webhooks
Testar webhook
/api/v1/utils/webhook/{user_id}/{webhook_type}Envia `{"event": "test", "webhook_type": "...", "data": {}}` para a URL cadastrada no tipo informado, com a mesma autenticação do envio real (HTTP Basic com as credenciais cadastradas no webhook). Responde com o resultado da entrega: `status` (`success`, `error` ou `timeout`), `health` (status HTTP, latência em ms e URL chamada) e `response_client` (corpo devolvido pelo cliente, truncado). O teste entra no histórico de webhooks enviados e pode ser inspecionado em `GET /user/webhook/{user_id}/{webhook_id}/inspection`. CUSTOMER só testa os próprios webhooks; SUPERUSER e DIRECTOR testam os de qualquer usuário. Limitado a 10 testes por hora por usuário.
Parâmetros de path
2 camposuser_idintegerObrigatórioCampo documentado pela API.
webhook_typestring · enumObrigatórioCampo documentado pela API.
Valores: pix_inpix_outaccount
Resposta
WebhookTestResponseSuccessful Response
Campos da resposta
4 camposstatusstringObrigatórioCampo documentado pela API.
healthobjectObrigatórioCampo documentado pela API.
sent_webhookobjectOpcionalCampo documentado pela API.
response_clientstringOpcionalCampo documentado pela API.
Status HTTP
Successful Response
Validation Error