Skip to main content

API channel

typestringrequired

Possible values: [api]

Example: api
webhook_urlstring

Webhook URL for API channel inbox callbacks

Example: https://example.com/webhook
hmac_mandatoryboolean

Require HMAC verification for incoming API channel messages

Example: false
additional_attributesobject

Additional attributes stored on contacts created through the API channel

Example: {"source":"mobile_app"}
API channel
{
  "type": "api",
  "webhook_url": "https://example.com/webhook",
  "hmac_mandatory": false,
  "additional_attributes": {
    "source": "mobile_app"
  }
}