Skip to navigation

Send an application message or receive a channel event

For application messaging use channel=api in the query and a ChannelApiToken from a deployed Channels API client. The body channel is a customer channel allowed for that client, such as email. Supply a unique id per message; retry the identical payload with the same id. A reused id with changed input or pending previous delivery returns 409. Omit conversationId to start a new conversation; include the returned ID to continue, keeping the same customerId and channel. Replies are asynchronous and arrive at the configured signed webhook. The JSON example documents API messaging; other transports use adapter-specific payloads.

Authentication

AuthorizationBearer

Token for one deployed API client, configured in Project → Channels.

OR
AuthorizationBearer

Short-lived widget session capability

OR
X-Twilio-Signaturestring
API Key authentication via header

Query parameters

channelstringRequiredDefaults to api

Ingress transport. Use api for application integrations. Other public transports are widget and twilio; their payloads and credentials differ.

workspaceIdstringRequired

Workspace identifier; required for API clients.

environmentenumRequiredDefaults to live
API messaging currently supports Live.
Allowed values:
integrationIdstringRequired
Enabled API client identifier from Channels.

Request

The JSON schema below describes channel=api. Widget sessions use their own JSON envelope; Twilio uses application/x-www-form-urlencoded. Internal AI callbacks are configured by LogicDialog.

idstringRequired1-100 characters
textstringRequired1-32000 characters
customerIdstringRequired1-320 characters
channelstringRequired1-40 characters
conversationIdstringOptional
subjectstringOptional<=500 characters

Response

Twilio SMS durably queued; empty TwiML acknowledgement.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error