Eagle Cash
Webhooks

Referência / Webhooks

Listar webhooks

GET/api/v1/user/webhook/{user_id}

Listar webhooks

Parâmetros de path

1 campo
user_idintegerObrigatório

Campo documentado pela API.

Parâmetros de query

1 campo
webhook_typestring · enumOpcional

Filter by webhook type

Valores: pix_inpix_outaccount

Resposta

200WebhookReadResponse

Successful Response

Campos da resposta

3 campos
webhook_pix_inarray<object>Opcional

Campo documentado pela API.

webhook_pix_outarray<object>Opcional

Campo documentado pela API.

webhook_accountarray<object>Opcional

Campo documentado pela API.

Status HTTP

200

Successful Response

422

Validation Error

Inspecionar entrega de webhook GET

Detalhe completo de um envio listado no histórico (`GET /utils/logs?platform=webhook`): payload enviado, resposta recebida, status HTTP e TTL restante em segundos. O `webhook_id` é o `id` da linha de log. O registro é lido do Redis (`services:webhooks:{user_id}:{tipo}:{webhook_id}`) e expira em 30 dias — depois disso a rota devolve 404, mesmo que a linha do histórico continue existindo. CUSTOMER só inspeciona os próprios envios; SUPERUSER e DIRECTOR inspecionam os de qualquer usuário.

Testar webhook POST

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.