Docs menu

Deploy and run

Webhook inboxes

A public URL that records every webhook sent to it, so you can see exactly what Stripe, GitHub or any service sends, and replay it to your app.

Explain it

Building something that receives webhooks (from Stripe, GitHub and so on) usually means guessing what will arrive. A webhook inbox is an address that records every request it gets and lets you replay any of them to your app as often as you like.

How to do it: open the project, choose Webhooks and flags, name an inbox and press Make an inbox. Paste its address into the other service's webhook settings, then replay what arrives to your app.

For webhooks CLI sends you, see Alerts and signed webhooks.

Building a webhook handler usually means guessing what the provider sends, then waiting for it to send it again. A webhook inbox is a URL that records every request it gets, with its method, headers and body, and replays any of them to your app as often as you like.

Make an inbox

In the dashboard: open the project, choose Webhooks and flags, name the inbox (like "Stripe") and press Make an inbox. Copy its URL into the provider's webhook settings.

To also send each webhook on to an app as it arrives, pick the app and a path (like /webhooks/stripe) when you make the inbox. The inbox keeps every delivery even when the app is asleep, redeploying or failing, and shows what the app answered.

Ask your agent:

"Make a webhook inbox for Stripe and give me the URL."

With the API:

API
POST /v1/projects/:id/webhook-inboxes
JSON
{ "name": "Stripe", "forwardServiceId": "svc_…", "forwardPath": "/webhooks/stripe" }

The answer includes url: https://<your CLI server>/hooks/<token>. Anything after the token is kept as the request's path, so …/hooks/<token>/events records the path /events.

See what arrived

Choose an inbox to see its latest requests. Select one for its headers and body (JSON is formatted). The inbox keeps the latest 200 requests, and the first 256 KB of each body.

CLI drops headers that carry credentials (Authorization, Cookie, Proxy-Authorization) and proxy headers before storing anything. Signature headers such as Stripe-Signature and X-Hub-Signature-256 are kept, so your handler can check them on replay.

API
GET /v1/webhook-inboxes/:id/captures

Replay to your app

Pick an app and press Replay to app. CLI sends the request as it arrived: same method, body and headers, plus X-CLI-Webhook-Replay with the capture's id.

API
POST /v1/webhook-captures/:id/replay
JSON
{ "serviceId": "svc_…", "path": "/webhooks/stripe" }

Delete an inbox with DELETE /v1/webhook-inboxes/:id; its URL stops working straight away.