Webhook Deliveries

Every time Inkbox POSTs an event to one of your endpoints, it records the attempt in a delivery log. Use this log to inspect delivery status and replay supported events your endpoint missed. Payload and response content may be omitted; the log is not a substitute for authorized conversation history. Companion events expose event/scope metadata and, when known, the current message’s sender_access at its normal message location, rather than conversation content in the delivery log. Manual replay returns 409; recover from the currently authorized activation snapshot. Automatic webhook retries continue to apply. Slack diagnostics contain event coordinates instead of the original message body; Slack deliveries cannot be replayed. The log covers both subscription deliveries (message.*, text.*, imessage.*, call.ended, a2a.*, slack.*) and the separate phone.incoming_call deliveries. Subscription deliveries carry a webhook_subscription_id (call.ended rows for calls on a number you own also carry that phone_number_id); incoming-call deliveries carry only a phone_number_id and are not replayable (their response body drives live call routing, so there’s nothing meaningful to replay).

Auth

Caller	Visibility
Admin-scoped API key	Every delivery in the organization.
Human session via the Inkbox Console	Every delivery in the organization.
Claimed agent-scoped API key	Deliveries for subscriptions and numbers belonging to that agent’s identity.

List deliveries

GET /webhooks/deliveries

List logged delivery attempts visible to the caller, newest first. Returns an object with a deliveries array — not a bare array.

Query parameters

Parameter	Type	Description
`subscription_id`	UUID	Filter to one subscription’s deliveries.
`phone_number_id`	UUID	Filter to a phone number’s call deliveries — its `phone.incoming_call` rows plus `call.ended` rows for calls on that number.
`event_type`	string	Filter by event type (e.g. `message.received`).
`success`	boolean	`true` returns only deliveries with a 2xx response; `false` returns failures (non-2xx or no response).
`limit`	integer	Page size, `1`–`200`. Defaults to `50`.
`offset`	integer	Row offset for pagination. Defaults to `0`.

Filters AND-combine.

Response (200)

JSON

{
  "deliveries": [
      {
          "id": "0a4e2c11-9f3b-4d8a-bf21-7a1e2c3d4e5f",
          "organization_id": "org_2abc123def456",
          "webhook_subscription_id": "9e1b3f2d-c4a6-4f8e-91bf-71d2c2e4f0a1",
          "phone_number_id": null,
          "event_id": "evt_8f2c1a9b-7d6e-4f4a-b2c1-d0e94b21c377",
          "event_type": "message.received",
          "url": "https://yourapp.example.com/webhooks/inkbox",
          "request_payload": "{\"id\": \"evt_8f2c1a9b-7d6e-4f4a-b2c1-d0e94b21c377\", \"event_type\": \"message.received\", \"timestamp\": \"2026-04-10T18:00:00Z\", \"data\": {}}",
          "response_status": 200,
          "response_body": "ok",
          "error_detail": null,
          "duration_ms": 142,
          "is_replay": false,
          "created_at": "2026-04-10T18:00:01Z"
      }
  ]
}

Code examples

curl -X GET "https://inkbox.ai/api/v1/webhooks/deliveries?success=false&limit=50" \
  -H "X-API-Key: YOUR_API_KEY"

const url = new URL("https://inkbox.ai/api/v1/webhooks/deliveries");
url.searchParams.set("success", "false");
const response = await fetch(url, {
  headers: { "X-API-Key": "YOUR_API_KEY" },
});
const { deliveries } = await response.json();

import requests

response = requests.get(
    "https://inkbox.ai/api/v1/webhooks/deliveries",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"success": False, "limit": 50},
)
deliveries = response.json()["deliveries"]

Replay delivery

POST /webhooks/deliveries/{delivery_id}/replay

For replayable channels, re-deliver a logged event to its subscription’s current URL — and, when one is set, its current auth_token (not the token from the original attempt) — recording a new delivery row (with is_replay set to true) for the attempt. Use replayable when deciding whether to offer replay. webhook_subscription_id identifies the subscription that received the original attempt and must still be active for replay. Replay preserves the original webhook envelope’s id. Deduplicate events using that field so a replay cannot repeat an action your receiver already completed. Each replay has fresh signature headers with a new request ID and timestamp.

Path parameters

Parameter	Type	Description
`delivery_id`	UUID	The logged delivery to replay.

Response (200)

Returns the new replay delivery row (is_replay: true). See Delivery object.

Error responses

Status	Reason
`404`	Delivery does not exist or is not visible to the caller.
`422`	The delivery is an incoming-call or Slack delivery, which is not replayable.
`409`	The subscription is no longer active.
`409`	The subscription no longer subscribes to this event type.
`409`	This is a Companion event. Load its currently authorized activation snapshot instead.

Code examples

curl -X POST "https://inkbox.ai/api/v1/webhooks/deliveries/DELIVERY_ID/replay" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch(
  `https://inkbox.ai/api/v1/webhooks/deliveries/${deliveryId}/replay`,
  {
      method: "POST",
      headers: { "X-API-Key": "YOUR_API_KEY" },
  }
);
const delivery = await response.json();

import requests

response = requests.post(
    f"https://inkbox.ai/api/v1/webhooks/deliveries/{delivery_id}/replay",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
delivery = response.json()

Delivery object

Field	Type	Description
`id`	UUID	Unique delivery identifier.
`organization_id`	string	Owning organization (e.g. `"org_2abc123def456"`).
`webhook_subscription_id`	UUID \| null	Original subscription this delivery targeted. `null` for incoming-call deliveries.
`replayable`	boolean	Whether the delivery is currently eligible for replay. The replay request checks eligibility again.
`replay_unavailable_reason`	string \| null	Reason replay is unavailable, or `null` when replay is allowed.
`phone_number_id`	UUID \| null	The number the call rode: set on `phone.incoming_call` rows (which have no subscription) and on `call.ended` rows for calls on a number you own. `null` otherwise, including `call.ended` rows for shared-line calls — use `webhook_subscription_id`, not this field, to tell the two call event types apart.
`event_id`	string	The payload envelope’s `id` (`evt_…`), shared across deliveries of the same event. For incoming-call rows this is the call ID.
`event_type`	string	The event type that was delivered.
`url`	string	The destination URL the request was sent to.
`request_payload`	string	Delivered request body or available event metadata. Companion and Slack events contain event/scope metadata rather than conversation content. Identity-scoped history omits contact enrichment and contact-scoped context. Request headers are not included.
`response_status`	integer \| null	HTTP status your endpoint returned. `null` if the request never got a response.
`response_body`	string \| null	A truncated response snippet. Unavailable for Companion and Slack events and omitted when contact enrichment is removed from identity-scoped history.
`error_detail`	string \| null	Transport error summary, when the request failed to complete.
`duration_ms`	integer \| null	How long the attempt took, in milliseconds.
`is_replay`	boolean	`true` if this row was produced by a manual replay.
`created_at`	string	ISO 8601 timestamp the attempt was made.

For event webhooks, the delivery record’s event_id equals the payload envelope’s id. Use it to correlate delivery attempts with the event your endpoint received.

Webhook subscriptions reference — subscription CRUD
Webhooks guide — payload verification, typed receiver examples, idempotency
Signing keys — per-identity keys used to verify webhook bodies

Agent signup API

Agent identity API

Agent2Agent API

Message retries

Mail API

Phone API

iMessage API

Slack API

Webhooks API

Tunnels API

Contacts API

Notes API

Vault API

Billing API

Webhook Deliveries

Auth

List deliveries

Query parameters

Response (200)

Code examples

Replay delivery

Path parameters

Response (200)

Error responses

Code examples

Delivery object

​Auth

​List deliveries

​Query parameters

​Response (200)

​Code examples

​Replay delivery

​Path parameters

​Response (200)

​Error responses

​Code examples

​Delivery object

​Related

Auth

List deliveries

Query parameters

Response (200)

Code examples

Replay delivery

Path parameters

Response (200)

Error responses

Code examples

Delivery object

Related