Skip to main content
The API channel lets you send customer messages to Botcadence over HTTPS. You get a webhook URL and an API key shown once at create time.

​
Prerequisites

  • Permission to create channels
  • A client that can POST JSON with an Authorization: Bearer header

​
Connect

1

Open Channels

In the project sidebar, select Channels.
2

Create API

Select API. Enter Channel Name and API Endpoint Name (the channel identifier, for example my-api-endpoint). Create the channel.
3

Save the API key

Copy Your API Key immediately. It is shown only once. Store it somewhere safe.
If you close the key dialog without copying, rotate the key later in channel settings (Rotate API Key). The old key stops working.

​
Verify

POST a test message to the webhook URL from the channel list, with Authorization: Bearer and your key. The conversation appears in Conversations.

​
Use it

Webhook URL: the endpoint shown for this channel (organization, project, and channel id). Authentication: Authorization: Bearer YOUR_API_KEY Example:
Replace ORG_ID, PROJECT_ID, CHANNEL_ID, and YOUR_API_KEY with your values. Do not commit real keys. In channel settings you can rename the channel. Channel Identifier cannot change. Use API Key Management to see a masked key and rotate it.

​
Limits

  • One API key is active at a time. Rotate invalidates the previous key.
  • The identifier is fixed after create.

​
Troubleshooting

Use the current key after a rotate. Send Authorization: Bearer with no extra quotes around the token.
Open the API channel settings and choose Rotate API Key. Copy the new key once.
Confirm the URL includes the correct organization, project, and channel ids, and that the JSON includes message and user_id.