inbox.created

Event triggered whenever an inbox is created.

All webhook payloads follow a consistent top-level structure with event-specific data nested within the data object.

• type (string) — The event type that triggered the webhook (e.g., inbox.created).

• created_at (string) — ISO 8601 timestamp when the webhook event was created.

• data (object) — Event-specific data containing detailed information about the event. The data object for the inbox.created event contains the following parameters:

  object parameters

  • source (api | dashboard | agent | system) — What made the change
  • inbox_id (string) — The ID of the inbox
  • inbox (object) — The inbox, as it is when the webhook is sentobject (string) — Always inboxid (string) — The ID of the inboxname (string) — Internal name for the inbox. Recipients do not see it. Falls back to the inbox addressemail_address (string) — The address of the inboxdomain_id (string) — The ID of the domain the inbox belongs toreceiving_address (string | null) — The address to forward mail to when forwarding is enabled. null otherwisefriendly_name (string | null) — The name recipients see when mail is sent from this inboxunread (number) — The number of unread threads in the inboxcreated_at (string) — ISO 8601 timestamp when the inbox was created

{
  "type": "inbox.created",
  "created_at": "2026-09-29T12:00:00.000Z",
  "data": {
    "source": "api",
    "inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
    "inbox": {
      "object": "inbox",
      "id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
      "name": "Customer Support",
      "email_address": "support@example.com",
      "domain_id": "d91cd9bd-1176-453e-8fc1-35364d380206",
      "receiving_address": null,
      "friendly_name": "Ada from Support",
      "unread": 3,
      "created_at": "2026-09-29T12:00:00.000Z"
    }
  }
}