Channel event types

After you enable Agora Notifications, Agora sends channel event notification callbacks to your server using HTTPS POST requests. The data format is JSON, the character encoding is UTF-8, and the signature algorithm is HMAC/SHA1 or HMAC/SHA256.

This page describes the event types and payloads returned in channel event callbacks.

Request parameters

Request header

Request body

Request example

{
  "noticeId": "2000001428:4330:107",
  "productId": 1,
  "eventType": 101,
  "notifyMs": 1611566412672,
  "payload": {}
}

Channel event types

channel create

The channel is created when the first user joins. The payload contains:

{
  "channelName": "test_webhook",
  "ts": 1560396834
}

channel destroy

The channel is destroyed when the last user leaves. The payload contains:

{
  "channelName": "test_webhook",
  "ts": 1560399999,
  "lastUid": 12121212
}

Join events

The following event types indicate that a user joined the channel:

• 103: broadcaster join channel
• 105: audience join channel
• 107: user join channel with communication mode

Join event payloads can contain the following fields:

{
  "channelName": "test_webhook",
  "uid": 12121212,
  "platform": 1,
  "clientSeq": 1625051030746,
  "ts": 1560396843,
  "account": "test"
}

Leave events

The following event types indicate that a user left the channel:

• 104: broadcaster leave channel
• 106: audience leave channel
• 108: user leave channel with communication mode

Leave event payloads can contain the following fields:

{
  "channelName": "test_webhook",
  "uid": 12121212,
  "platform": 1,
  "clientSeq": 1625051030789,
  "reason": 1,
  "ts": 1560396943,
  "duration": 600,
  "account": "test"
}

Client role change events

The following event types indicate that a user's live broadcasting role changed:

• 111: client role change to broadcaster
• 112: client role change to audience

Payloads contain:

{
  "channelName": "test_webhook",
  "uid": 12121212,
  "clientSeq": 1625051035469,
  "ts": 1560396834,
  "account": "test"
}