Introduction

Use cases

Integrate to an external platform, like a CRM, or connect to your own bot.

Configuration

Webhooks

The first step is to register a webhook address. It could be done by contacting our customer support.

By registering a webhook you should start to receiving webhooks with the following format:

{
  "objectId": "c1KjTsOhDP",
  "resource": "Message",
  "event": "CREATE",
  "timestamp": 1681825655283,
  "payload": {
    "chat": {
      "className": "Chat",
      "objectId": "dE5fgIIi8o"
    },
    "platform": "WAB-OMNICHAT",
    "status": "INCOMING_RECEIVED",
    "system": false,
    "type": "TEXT",
    "text": "bom dia",
    "createdAt": "2023-04-18T13:47:35.255Z",
    "updatedAt": "2023-04-18T13:47:35.255Z",
    "objectId": "c1KjTsOhDP"
  }
}

You can find a complete webhook reference here.

API user

The next step is registering an API user.

It can be done at Integration API window