Jump to

Webhooks API

Webhook delivery flows through a channel-agnostic subscription resource. Each subscription names one owner — a mailbox, a phone number, or an agent identity — one HTTPS destination URL, and a non-empty subset of the event catalog. Many subscriptions can attach to the same owner; each URL receives its own POST per event, independently.

Signing keys are per agent identity. Each identity has its own key that verifies the webhooks for that identity's mailbox, phone number, iMessage, and call-lifecycle traffic — see Signing keys.

For payload shapes, signing-key verification, and typed receiver examples, see the Webhooks guide, the Mail webhooks reference, and the Phone webhooks reference.

API base URL:

https://inkbox.ai/api/v1/webhooks

Quick start

Create an account and get your API key from the Inkbox console:

Get API key

All webhook subscription endpoints require an API key. Admin-scoped keys and human Console sessions can manage any subscription in the organization; claimed agent-scoped keys can only manage subscriptions whose owning mailbox or phone number belongs to their identity.

X-API-Key: YOUR_API_KEY

Subscriptions

Create subscription

POST

Attach an HTTPS URL + event-type list to a mailbox, phone number, or agent identity

/api/v1/webhooks/subscriptions

List subscriptions

GET

List active subscriptions, optionally filtered by owner / URL / event type

/api/v1/webhooks/subscriptions

Get subscription

GET

Fetch one subscription by ID

/api/v1/webhooks/subscriptions/{sub_id}

Update subscription

PATCH

Change the destination URL and/or event-type list

/api/v1/webhooks/subscriptions/{sub_id}

Delete subscription

DELETE

Remove a subscription — delivery stops immediately

/api/v1/webhooks/subscriptions/{sub_id}

Deliveries

Every outbound webhook attempt is recorded in a delivery log: the signed request body that was sent, the endpoint's response (or transport error), and timing. Inspect what was — or wasn't — delivered, and replay a missed delivery to its subscription's current URL.

List deliveries

GET

List logged delivery attempts, optionally filtered by subscription / event type / success

/api/v1/webhooks/deliveries

Replay delivery

POST

Re-deliver a logged event to its subscription's current URL

/api/v1/webhooks/deliveries/{delivery_id}/replay

`phone.incoming_call` is configured per-number

The phone.incoming_call event is a synchronous control-plane callback — the response body decides whether Inkbox answers the call — so it doesn't fan out through subscriptions. Configure it via the incoming_call_webhook_url field on the phone number resource.

Additional resources

Webhook subscriptions reference — subscription CRUD
Webhook deliveries reference — delivery log + replay
Webhooks guide — payload verification, typed receiver examples
Mail webhooks reference
Phone webhooks reference
Signing keys