Webhooks API
Webhook delivery flows through a channel-agnostic subscription resource. Each subscription names one owner — a mailbox or a phone number — 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.
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/webhooksQuick start
Create an account and get your API key from the Inkbox console:
Get API keyAll 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_KEYSubscriptions
Create subscription
POSTAttach an HTTPS URL + event-type list to a mailbox or phone number
/api/v1/webhooks/subscriptionsList subscriptions
GETList active subscriptions, optionally filtered by owner / URL / event type
/api/v1/webhooks/subscriptionsGet subscription
GETFetch one subscription by ID
/api/v1/webhooks/subscriptions/{sub_id}Update subscription
PATCHChange the destination URL and/or event-type list
/api/v1/webhooks/subscriptions/{sub_id}Delete subscription
DELETERemove a subscription — delivery stops immediately
/api/v1/webhooks/subscriptions/{sub_id}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
- Webhooks guide — payload verification, typed receiver examples
- Mail webhooks reference
- Phone webhooks reference
- Signing keys