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

Webhook Inbox Metadata API - Check Inbox Status

Returns the inbox creation time, the receive URL (where to POST webhooks), the payloads URL (where to GET captured data), and the current payload count. Use this to confirm an inbox is still alive before sending traffic.

Parameters

stringrequired

The inbox ID returned by the create endpoint.

Code examples

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

When to use this API

Poll an inbox to check whether any payloads have arrived yet

Before spending tokens on listing full payloads, hit the metadata endpoint to see payload_count. If it is zero, no webhook has been delivered and you can skip the list call.

Verify an inbox exists before handing the URL to a customer

In an integration testing dashboard, call GET on the inbox before rendering the receive URL. A 404 tells you the inbox expired so you can rotate it transparently.

Frequently asked questions

Does GET /inbox/:id return the captured payloads?
No. This endpoint only returns metadata and a payload count. Use GET /v1/webhook/inbox/{id}/payloads to retrieve the captured bodies.
What does a 404 mean here?
Either the inbox ID is wrong, or the inbox expired (24-hour TTL). Create a new inbox with /v1/webhook/inbox/create.
Is this endpoint rate-limited?
Anonymous access: 5 requests per minute per IP, 100 per day. API key access: no rate limit.

Get your API key

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