Pular para o conteúdo
POST AI agent ready /v1/webhook/inbox/:id/list

API Webhook Payload List - Visualizador de caixa de entrada gratuito

Recupere cada carga capturada por uma caixa de entrada de webhook, incluindo o corpo da solicitação, carimbo de data/hora e um ID de carga útil exclusivo. Retorna até 50 das cargas mais recentes. A caixa de entrada deve ter sido criada por meio do endpoint /v1/webhook/inbox/create.

Parameters

stringrequired

The inbox ID returned by the create endpoint.

Code examples

curl -X POST https://api.botoi.com/v1/webhook/inbox/:id/list \
  -H "Content-Type: application/json" \
  -d '{"id":"a1b2c3d4"}'

When to use this API

Inspecione a estrutura exata de carga útil que um provedor de webhook envia

Depois de acionar um evento de teste, liste as cargas da caixa de entrada para ver o corpo JSON bruto. Use isso para criar interfaces digitadas para seu manipulador de webhook sem adivinhar o esquema.

Verifique se o seu encaminhador de webhook transmite as cargas corretamente

Se você rotear webhooks por meio de um proxy ou fila, aponte a saída do proxy para uma caixa de entrada de teste. Compare as cargas listadas com a carga do provedor original para confirmar que nada foi alterado.

Crie testes de integração automatizados para consumidores de webhook

Crie uma caixa de entrada em seu conjunto de testes, envie uma carga útil de webhook simulada e, em seguida, chame o endpoint da lista para afirmar que a carga chegou. Não são necessários servidores simulados.

Frequently asked questions

O que acontece se o ID da caixa de entrada não existir ou tiver expirado?
A API retorna um erro 404 com o código INBOX_NOT_FOUND. Crie uma nova caixa de entrada se a sua tiver expirado.
As cargas úteis são retornadas em ordem cronológica?
Sim. As cargas úteis são classificadas pelo carimbo de data/hora recebido_at, o mais antigo primeiro. As 50 cargas úteis mais recentes estão incluídas.
Posso excluir cargas individuais de uma caixa de entrada?
Não. As cargas úteis não podem ser excluídas individualmente. Eles expiram automaticamente na caixa de entrada após 24 horas.
Este endpoint retorna o corpo completo da carga útil?
Sim. O corpo JSON completo enviado para a URL de recebimento da caixa de entrada é armazenado e retornado no campo body de cada entrada de carga útil.
O ID da caixa de entrada é passado na URL ou no corpo da solicitação?
O ID da caixa de entrada é passado no caminho da URL: /v1/webhook/inbox/{id}/list. O corpo da solicitação pode estar vazio.

Get your API key

Free tier includes 5 requests per minute with no credit card required. Upgrade for higher limits.