Inkbox

> # Documentation index
> Fetch the complete documentation index at: https://inkbox.ai/sitemap.xml
> Use this file to discover all available pages before exploring further.

---

# Webhooks API
description: Subscribe HTTPS endpoints to mail and phone-text events via the webhook-subscription resource

---


# 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](/docs/webhooks). 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](/docs/webhooks), the [Mail webhooks reference](/docs/api/mail/webhooks), and the [Phone webhooks reference](/docs/api/phone/webhooks).

API base URL:


## Quick start

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

[Get API key](https://inkbox.ai/console/api-keys)

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.


## Subscriptions


  **[Create subscription](/docs/api/webhooks/subscriptions)** `POST` `/api/v1/webhooks/subscriptions` — Attach an HTTPS URL + event-type list to a mailbox or phone number

  **[List subscriptions](/docs/api/webhooks/subscriptions)** `GET` `/api/v1/webhooks/subscriptions` — List active subscriptions, optionally filtered by owner / URL / event type

  **[Get subscription](/docs/api/webhooks/subscriptions)** `GET` `/api/v1/webhooks/subscriptions/{sub_id}` — Fetch one subscription by ID

  **[Update subscription](/docs/api/webhooks/subscriptions)** `PATCH` `/api/v1/webhooks/subscriptions/{sub_id}` — Change the destination URL and/or event-type list

  **[Delete subscription](/docs/api/webhooks/subscriptions)** `DELETE` `/api/v1/webhooks/subscriptions/{sub_id}` — Remove a subscription — delivery stops immediately


## `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](/docs/api/phone/numbers).

## Additional resources

- [Webhooks guide](/docs/webhooks) — payload verification, typed receiver examples
- [Mail webhooks reference](/docs/api/mail/webhooks)
- [Phone webhooks reference](/docs/api/phone/webhooks)
- [Signing keys](/docs/signing-keys)