API Inbox

This page guides you through setting up the API inbox

How to setup a API channel?

To create and configure an API channel inbox in our service installations, follow the step described below.

Step 1. Go to Engagement Hub → Settings → Inboxes → “Add Inbox”.

Step 2. Click on the "API" icon.

Step 3. Provide a name for the channel and a callback URL. Here is an example:

Step 4. "Add operators" to your API inbox.

Step 5. "Add agents" to your API inbox.

The inbox setup is complete.

Receive messages using callback URL

When a new message is created in the API channel, you will get a POST request to the Callback URL specified while creating the API channel. The payload would look like this.

{
  {
    "conversationId": "conversation-id",
    "messages": [
      {
        "id": 1,
        "content": "Where I can buy shoes in New York?",
        "messageType": "incoming",
        "AIgenerated": false
      },
      {
        "id": 2,
        "content": "New York City offers a variety of great shoe stores depending on your style and preferences.",
        "messageType": "outgoing",
        "AIgenerated": true
      }
    ]
  }
}