Platform Support

Setup

This webhook is sent to the URL specified in the real_time_media.webhook_chat_messages_destination_url parameter in the Create Bot endpoint.

Then, as long as the bot is in thein_call_recording or in_call_not_recording states, the configured endpoint will receive chat messages as webhook events.

Verification

We recommend implementing verification by including a query parameter, such as token=your-random-token, in the URL you provide. When we make the request to your endpoint, we will use the exact url, including any query parameters. You will then be able to verify the query parameter in your webhook handler.

Chat Message Event Payload

This webhook is sent when new chat messages(readable by the bot) are posted in the meeting.

{
  "event": "bot.chat_message",
  "data": {
    "bot_id": string,
    "created_at": string,
    "to": string, // "everyone" or "only_bot"
    "text": string,
    "sender": {
      "id": integer,
      "is_host": boolean,
      "name": string,
      "platform": string, // ('unknown', 'desktop', 'mobile_app', 'dial_in')
      "extra_data": object,
    }
  }
}

FAQ

Are emoji reactions detected by the bot?

Emoji reactions are currently supported on the Zoom platform.

What happens if my webhook endpoint returns a non-2xx response?

There currently is no retry policy on the chat message webhooks. We recommend you enqueue a job upon receiving a chat message webhook in which you can control the retry behavior. You can instead query chat messages at any time using hte List Chat Messages endpoint.