GET AI agent ready /v1/webhook/inbox/:id/payloads

Webhook Payloads API - Fetch Captured Webhook Data

Retrieve every payload captured by a webhook inbox, including the request body, timestamp, and a unique payload ID. Returns up to 50 of the most recent payloads. REST-convention endpoint: simple GET request, no body needed. The inbox must have been created via the /v1/webhook/inbox/create endpoint.

Endpoint

Code examples

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

When to use this API

Inspect the exact payload structure a webhook provider sends

After triggering a test event, fetch the inbox payloads to see the raw JSON body. Use this to build typed interfaces for your webhook handler without guessing at the schema.

Verify that your webhook forwarder passes payloads correctly

If you route webhooks through a proxy or queue, point the proxy output to a test inbox. Compare the listed payloads against the original provider payload to confirm nothing was altered.

Build automated integration tests for webhook consumers

Create an inbox in your test suite, send a simulated webhook payload, then fetch the payloads endpoint to assert delivery. No mock servers needed.

Frequently asked questions

What happens if the inbox ID does not exist or has expired?

The API returns a 404 error with the code INBOX_NOT_FOUND. Create a new inbox if yours has expired.

Are payloads returned in chronological order?

Yes. Payloads are sorted by received_at timestamp. The most recent 50 payloads are included.

Can I delete individual payloads from an inbox?

No. Payloads cannot be deleted individually. They expire automatically with the inbox after 24 hours.

Does this endpoint return the full payload body?

Yes. The complete JSON body sent to the inbox receiving URL is stored and returned in the body field of each payload entry.

Is there a POST version of this endpoint?

Yes. POST /v1/webhook/inbox/{id}/list is kept as a backward-compatible alias and returns the same response. New integrations should use GET /v1/webhook/inbox/{id}/payloads.

Get your API key

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