INinkbox
Webhooks

Create Subscription

Changed on
post/api/v1/webhooks/subscriptions

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/webhooks/subscriptions
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Request body

mailbox_idstring uuid nullable
phone_number_idstring uuid nullable
agent_identity_idstring uuid nullable
urlstring required
auth_tokenstring nullable

Optional bearer token for endpoints that require it; sent as 'Authorization: Bearer <token>' on every delivery and returned on subscription reads.

Response

Successful Response

idstring uuid required
organization_idstring required
mailbox_idstring uuid nullable
phone_number_idstring uuid nullable
agent_identity_idstring uuid nullable
owner_identity_idstring uuid nullable
urlstring required
auth_tokenstring nullable
has_auth_tokenboolean
status'active' | 'deleted' required
created_atstring date-time required
updated_atstring date-time required
signing_keystring nullable

Changes

  • 7e848337e8bfRevision changes
    • info

      added to the / request property anyOf list

    • info

      added to the / response property anyOf list for the response status

  • 77c7e3ee70cfRevision changes
    • info

      added to the response body allOf list for the response status

    • info

      removed subschema #1 from the response body allOf list for the response status