Channels

Create an API channel

Create a bidirectional API channel and obtain its inbound endpoint and one-time signing secret.

Updated 2026-07-24For: Administrators · Developers

The API channel integrates customer conversations from your product; it is not a general management API. Customer messages enter through the inbound endpoint and public replies and lifecycle events return to your callback.

Steps

Add the API channel

Open Channels and choose Add entry → API.

Configure the callback

Enter a channel name and callback URL, then complete team and AI settings.

Store credentials

After creation, immediately store the inbound URL and signingSecret. The secret is shown only once.

Test the callback

Run the callback test from channel details and confirm that your service returns a 2xx response.

Complete the integration

Follow the developer docs for signing, messages, attachments, event deduplication, and retries.

Related guides