Receive notifications about channel events

A webhook is a user-defined callback over HTTP. You use webhooks to notify your app or back-end system when certain Voice Calling events occur. Agora Notifications enables you to subscribe to events and receive notifications about them across multiple product lines.

Using Agora Console you subscribe to specific events for your project and tell Notifications the URL of the webhooks you have configured to receive these events. Notifications sends notifications of your events to your webhooks every time they occur. Your server authenticates the notification and returns 200 Ok to confirm reception. You use the information in the JSON payload of each notification to give the best user experience to your users.

The following figure illustrates the workflow when Notifications is enabled for the specific Voice Calling events you subscribe to:

1. A user commits an action that creates an event. For example, creates a channel.
2. Notifications sends an HTTPS POST request to your webhook.
3. Your server validates the request signature, then sends a response to Notifications within 10 seconds. The response body must be in JSON.

If Notifications receives 200 OK within 10 seconds of sending the initial notification, the callback is considered successful. If these conditions are not met, Notifications immediately resends the notification. The interval between notification attempts gradually increases. Notifications stops sending notifications after three retries.

To set up and use Notifications, you must have:

• A valid Agora account.

• An active Agora project.

• A computer with Internet access.

  If your network access is restricted by a firewall, call the IP address query API to retrieve the Notifications IP addresses , then configure the firewall to allow these IP addresses.

In order to handle notifications for the events you subscribe to, you need to:

• Create your webhook
• Enable Notifications
• Verify Notifications signatures

• Handle redundant notifications and abnormal user activity
• Implement online user status tracking

Once Notifications is enabled, Agora SD-RTN™ sends notification callbacks as HTTPS POST requests to your webhook when events that you are subscribed to occur. The data format of the requests is JSON, the character encoding is UTF-8, and the signature algorithm is HMAC/SHA1 or HMAC/SHA256.

For Notifications, a webhook is an endpoint on an HTTP server that handles these requests. In a production environment you write this in your web infrastructure, for development purposes best practice is to create a simple local server and use a service such as ngrok to supply a public URL that you register with Agora SD-RTN™ when you enable Notifications.

To do this, take the following steps:

1. Set up a Java project for your server

   Your server receives and handles notifications. The RootHandler handles requests sent to the root address of your server and the NcsHandler handles the notifications sent to <your server address>/ncsNotify. To set up your server, create a new Java project and add the following code to a file named Main.java:

   import java.io.IOException;
   

   import java.net.InetSocketAddress;
   

   import com.sun.net.httpserver.HttpServer;
   

   
   

   public class Main {
   

   public static int port = 80;
   

   
   

   public static void main(String[] args) {
   

   // Start http server
   

   SimpleHttpServer httpServer = new SimpleHttpServer();
   

   httpServer.Start(port);
   

   }
   

   
   

   static class SimpleHttpServer {
   

   private HttpServer server;
   

   
   

   public void Start(int port) {
   

   try {
   

   server = HttpServer.create(new InetSocketAddress(port), 0);
   

   System.out.println("Notifications webhook server started on port " + port);
   

   server.createContext("/", new Handlers.RootHandler());
   

   server.createContext("/ncsNotify", new Handlers.NcsHandler());
   

   server.setExecutor(null);
   

   server.start();
   

   } catch (IOException e) {
   

   e.printStackTrace();
   

   }
   

   }
   

   
   

   public void Stop() {
   

   server.stop(0);
   

   }
   

   }
   

   }
   

2. Add a JSON library to your project

   The body of an HTTP request that your server receives contains event parameters in JSON format. To read these parameters download the json-simple-1.1.1.jar library and add it to your JAVA project.

3. Handle Notifications callbacks

   To define the RootHandler and the NcsHandler, create a new file named Handlers.java in your Java project folder. Add the following code to this file:

   import java.io.BufferedReader;
   

   import java.io.IOException;
   

   import java.io.InputStreamReader;
   

   import java.io.OutputStream;
   

   import java.util.stream.Collectors;
   

   
   

   import com.sun.net.httpserver.Headers;
   

   import com.sun.net.httpserver.HttpExchange;
   

   import com.sun.net.httpserver.HttpHandler;
   

   import org.json.simple.JSONObject;
   

   import org.json.simple.parser.JSONParser;
   

   
   

   public class Handlers {
   

   
   

   public static class RootHandler implements HttpHandler {
   

   @Override
   

   public void handle(HttpExchange he) throws IOException {
   

   String response = "<h1>Agora Notifications demo</h1>" + "<h2>Port: " + Main.port + "</h2>";
   

   he.sendResponseHeaders(200, response.length());
   

   OutputStream os = he.getResponseBody();
   

   os.write(response.getBytes());
   

   os.close();
   

   }
   

   }
   

   
   

   public static class NcsHandler implements HttpHandler {
   

   
   

   @Override
   

   public void handle(HttpExchange he) throws IOException {
   

   Headers headers = he.getRequestHeaders();
   

   // Read signatures from the request header
   

   String agoraSignature = headers.getFirst("Agora-Signature");
   

   //String agoraSignatureV2 = headers.getFirst("Agora-Signature-V2");
   

   
   

   InputStreamReader isr = new InputStreamReader(he.getRequestBody(), "utf-8");
   

   BufferedReader br = new BufferedReader(isr);
   

   
   

   // Read the request body
   

   String body = br.lines()
   

   .collect(Collectors.joining(System.lineSeparator()));
   

   
   

   String noticeId, channelName = "";
   

   long productId, clientSeq = 0;
   

   int uid = 0, eventType;
   

   
   

   // Read event parameters from JSON in the request body
   

   try {
   

   JSONObject jsonObj = (JSONObject) new JSONParser().parse(body);
   

   
   

   noticeId = (String) jsonObj.get("noticeId");
   

   productId = (long) jsonObj.get("productId");
   

   eventType = (int) (long) jsonObj.get("eventType");
   

   JSONObject payload = (JSONObject) jsonObj.get("payload");
   

   
   

   // Read payload
   

   if (payload.containsKey("clientSeq"))
   

   clientSeq = (long) payload.get("clientSeq");
   

   
   

   if (payload.containsKey("uid"))
   

   uid = (int) (long) payload.get("uid");
   

   
   

   if (payload.containsKey("channelName"))
   

   channelName = (String) payload.get("channelName");
   

   
   

   System.out.println(
   

   "Event code: " + eventType
   

   + " Uid: " + uid
   

   + " Channel: " + channelName
   

   + " ClientSeq: " + clientSeq);
   

   
   

   } catch (Exception e) {
   

   System.out.println("Error parsing JSON: " + e.toString());
   

   return;
   

   }
   

   
   

   // Send OK response code 200
   

   String response = "Ok";
   

   he.sendResponseHeaders(200, response.length());
   

   OutputStream os = he.getResponseBody();
   

   os.write(response.toString().getBytes());
   

   os.close();
   

   
   

   }
   

   }
   

   
   

   }
   

4. Create a public URL for your server

   In this example you use ngrok to create a public URL for your server.

   1. Download and install ngrok. If you have Chocolatey, use the following command:

      choco install ngrok
      

   2. Add an authtoken to ngrok:

      ngrok config add-authtoken <authToken>
      

      To obtain an authToken, sign up with ngrok.

   3. Start a tunnel to your local server using the following command:

      ngrok http <local server port>
      

      You see a Forwarding URL displayed such as https://1111-123-456-789-99.ap.ngrok.io. This is the public URL for your local server that you use to enable Notifications.

To enable Notifications:

1. Log in to Agora Console. On the Project Management tab, locate the project for which you want to enable Notifications and click Configure.

2. In the Features section, locate Notifications, and click Enable.

3. On the configuration page, click on the service for which you want to enable notifications. The item expands to show configuration options.

4. Fill in the following information:

   • Event: Select all the events that you want to subscribe to.

     If the selected events generate a high number of queries per second (QPS), ensure that your server has sufficient processing capacity.

   • Receiving Server Region: Select the region where your server that receives the notifications is located. Agora connects to the nearest Agora node server based on your selection.

   • Receiving Server URL Endpoint: The HTTPS public address of your server that receives the notifications. For example, https://1111-123-456-789-99.ap.ngrok.io/ncsNotify.

     • To enhance security, Notifications no longer supports HTTP addresses.

     • To reduce the delay in notification delivery, best practice is to activate HTTP persistent connection (also called HTTP keep-alive) on your server with the following settings:

       • MaxKeepAliveRequests: 100 or more
       • KeepAliveTimeout: 10 seconds or more

   • Whitelist: If your server is behind a firewall, check the box here, and ensure that you call the IP address query API to get the IP addresses of the Agora Notifications server and add them to the firewall's allowed IP list.

5. Copy the Secret displayed against the product name by clicking the copy icon. You use this secret to Add signature verification.

6. Press Save. Agora performs a health test for your configuration as follows:

   1. The Notifications health test generates test events that correspond to your subscribed events, and then sends test event callbacks to your server.

      In test event callbacks, the channelName is test_webhook, and the uid is 12121212.

   2. After receiving each test event callback, your server must respond within 10 seconds with a status code of 200. The response body must be in JSON format.

   3. When the Notifications health test succeeds, read the prompt and press Save Notifications Configuration. After your configuration is saved, the Status of Notifications shows Enabled.

      If the Notifications health test fails, follow the prompt on the Agora Console to troubleshoot the error. Common errors include the following:

      • Request timeout (590): Your server does not return the status code 200 within 10 seconds. Check whether your server responds to the request properly. If your server responds to the request properly, contact Agora Technical Support to check if the network connection between the Agora Notifications server and your server is working.

      • Domain name unreachable (591): The domain name is invalid and cannot be resolved to the target IP address. Check whether your server is properly deployed.

      • Certificate error (592): The Agora Notifications server fails to verify the SSL certificates returned by your server. Check if the SSL certificates of your server are valid. If your server is behind a firewall, check whether you have added all IP addresses of the Agora Notifications server to the firewall's allowed IP list.

      • Other response errors: Your server returns a response with a status code other than 200. See the prompt on the Agora Console for the specific status code and error messages.

To communicate securely between Notifications and your webhook, Agora SD-RTN™ uses signatures for identity verification as follows:

1. When you configure Notifications in Agora Console, Agora SD-RTN™ generates the secret you use for verification.

2. When sending a notification, Notifications generates two signature values from the secret using HMAC/SHA1 and HMAC/SHA256 algorithms. These signatures are added as Agora-Signature and Agora-Signature-V2 to the HTTPS request header.

3. When your server receives a callback, you can verify Agora-Signature or Agora-Signature-V2.

   • To verify Agora-Signature, use the secret, the raw request body, and the HMAC/SHA1 algorithm.
   • To verify Agora-Signature-V2, use the secret, the raw request body, and the HMAC/SHA2 algorithm.

To add signature verification to your server, take the following steps:

1. In your JAVA project folder, add a new file named Signature.java containing the following code:

   import javax.crypto.Mac;
   

   import javax.crypto.spec.SecretKeySpec;
   

   
   

   public class Signature {
   

   static String secret = "<your NCS secret>";
   

   
   

   public static String bytesToHex(byte[] bytes) {
   

   // Convert an encrypted byte array into a hex string
   

   StringBuffer sb = new StringBuffer();
   

   for (int i = 0; i < bytes.length; i++) {
   

   String hex = Integer.toHexString(bytes[i] & 0xFF);
   

   if (hex.length() < 2) {
   

   sb.append(0);
   

   }
   

   sb.append(hex);
   

   }
   

   return sb.toString();
   

   }
   

   
   

   // Use the HMAC/SHA1 algorithm and get the encrypted hex string
   

   // To use the HMAC/SHA256 algorithm, replace "HmacSHA1" with "HmacSHA256"
   

   public static String hmacSha1(String message) {
   

   try {
   

   SecretKeySpec signingKey = new SecretKeySpec(secret.getBytes(
   

   "utf-8"), "HmacSHA1");
   

   Mac mac = Mac.getInstance("HmacSHA1");
   

   mac.init(signingKey);
   

   byte[] rawHmac = mac.doFinal(message.getBytes("utf-8"));
   

   return bytesToHex(rawHmac);
   

   } catch (Exception e) {
   

   throw new RuntimeException(e);
   

   }
   

   }
   

   
   

   public static boolean verify(String request_body, String signature) {
   

   // Check the signature against the encrypted request body
   

   // Returns true if the signature matches the encrypted hex string
   

   return (hmacSha1(request_body).equals(signature));
   

   }
   

   }
   

   Make sure you update your Notifications secret in the code. To verify authenticity using Agora-Signature-V2, replace HmacSHA1 with HmacSHA256 in the sample code.

2. To verify data in the Notifications callback, add the following code to NcsHandler:

   // Pass the request body and the signature from the request header
   

   boolean isVerified = Signature.verify(body, agoraSignature);
   

   System.out.println("Signature verified: " + isVerified);
   

When using Notifications to maintain the online status of your app users, your server might experience the following issues:

• Message notifications are redundant. You receive multiple notifications because the Agora Notifications server can send more than one notification callback for each channel event to ensure reliability of the service.

• Message notifications arrive out of order. Network issues cause callbacks to arrive at your server in a different order than the order of event occurrence.

To accurately maintain the online status of users, your server needs to be able to deal with redundant notifications and handle received notifications in the same order as events occur. The following section shows you how to use channel event callbacks to accomplish this.

Agora Notifications sends RTC channel event callbacks to your server. All channel events, except for 101 and 102 events, contain the clientSeq field (Unit64) in payload, which represents the sequence number of an event. This field is used to identify the order in which events occur on the app client. For notification callbacks reporting the activities of the same user, the value of the clientSeq field increases as events happen.

Refer to the following steps to use the clientSeq field to enable your server to handle redundant messages, and messages arriving out of order:

1. Enable Agora Notifications, and subscribe to RTC channel event callbacks. Best practice is to subscribe to the following event types according to your scenario:

   • In the LIVE_BROADCASTING profile: 103, 104, 105, 106, 111, and 112.
   • In the COMMUNICATION profile: 103, 104, 111, and 112.

2. Use the channel event callbacks to get the latest status updates about the following at your server:

   • Channel lists
   • User lists in each channel
   • Data for each user, including the user ID, user role, whether the user is in a channel, and clientSeq of channel events

3. When receiving notification callbacks of a user, search for the user in the user lists. If there is no data for the user, create data specific to the user.

4. Compare the value in the clientSeq field of the latest notification callback you receive with that of the last notification callback handled by your server:

   • If the former is greater than the latter, the notification callback needs to be handled.
   • If the former is less than the latter, the notification callback should be ignored.

5. When receiving notification callbacks reporting a user leaving a channel, wait for one minute before deleting the user data. If it is deleted immediately, your server cannot handle notifications in the same order as channel events happen when receiving redundant notifications or notifications out of order.

When your server receives a notification callback of event 104 with reason as 999, it means that the user is considered to have abnormal activities due to frequent login and logout actions. In this case, best practice is that your server calls the Banning user privileges API to remove the user from the current channel one minute after receiving such notification callback; otherwise, the notification callbacks your server receives about the user's events might be redundant or arrive out of order, which makes it hard for you to accurately maintain the online status of this user.

This section provides sample Java code to show how to use channel event callbacks to maintain online user status at your app server.

To maintain a user registry, take the following steps:

1. Create a new file in you JAVA project folder named UserRegistry.java containing the following code.

   import java.util.HashMap;
   

   import java.util.Timer;
   

   import java.util.TimerTask;
   

   
   

   public class UserRegistry {
   

   public static int EVENT_BROADCASTER_JOIN = 103;
   

   public static int EVENT_BROADCASTER_QUIT = 104;
   

   public static int EVENT_AUDIENCE_JOIN = 105;
   

   public static int EVENT_AUDIENCE_QUIT = 106;
   

   public static int EVENT_CHANGE_ROLE_TO_BROADCASTER = 111;
   

   public static int EVENT_CHANGE_ROLE_TO_AUDIENCE = 112;
   

   
   

   public static int ROLE_BROADCASTER = 1;
   

   public static int ROLE_AUDIENCE = 2;
   

   public static int WAIT_TIMEOUT_MS = 60 * 1000;
   

   private static Timer timer = new Timer();
   

   
   

   class User { // Holds user information
   

   int uid; // user ID
   

   int role; // user role
   

   boolean isOnline; // whether the user is in a channel
   

   long lastClientSeq; // clientSeq of the last event handled by your server
   

   
   

   public User(int uid, int role, boolean isOnline, long clientSeq) {
   

   this.uid = uid;
   

   this.role = role;
   

   this.isOnline = isOnline;
   

   this.lastClientSeq = clientSeq;
   

   }
   

   };
   

   
   

   // Channel list
   

   private static HashMap<String, Channel> channels = new HashMap<>();;
   

   
   

   class Channel { // Holds the list of users in each channel
   

   HashMap<Integer, User> users = new HashMap<>();
   

   };
   

   
   

   // Process Agora Notifications callbacks to update user registry
   

   public void HandleNcsEvent(String channelName, int uid, int eventType, long clientSeq) {
   

   // Check the eventType to process events that notify of users joining or
   

   // leaving a channel or a change in the user role
   

   if (eventType != EVENT_BROADCASTER_JOIN &&
   

   eventType != EVENT_BROADCASTER_QUIT &&
   

   eventType != EVENT_AUDIENCE_JOIN &&
   

   eventType != EVENT_AUDIENCE_QUIT &&
   

   eventType != EVENT_CHANGE_ROLE_TO_BROADCASTER &&
   

   eventType != EVENT_CHANGE_ROLE_TO_AUDIENCE) {
   

   
   

   return;
   

   }
   

   
   

   // Determine whether a user is online
   

   boolean isOnlineInNotice = IsUserOnlineInNotice(eventType);
   

   // Get the user role from eventType
   

   int roleInNotice = GetUserRoleInNotice(eventType);
   

   
   

   Channel channel = channels.get(channelName);
   

   if (channel == null) {
   

   // If a channel does not exist, create a channel and add it to the list
   

   channel = new Channel();
   

   channels.put(channelName, channel);
   

   System.out.println("New channel " + channelName + " created");
   

   }
   

   
   

   User user = channel.users.get(uid);
   

   // Get whether a user has left a channel
   

   boolean isQuit = !isOnlineInNotice && (user == null || user.isOnline);
   

   if (user == null) {
   

   // Create a new user and add it to the user list of the corresponding channel
   

   user = new User(uid, roleInNotice, isOnlineInNotice, clientSeq);
   

   channel.users.put(uid, user);
   

   
   

   if (isOnlineInNotice) {
   

   System.out.println("New User " + uid + " joined channel " + channelName);
   

   } else {
   

   // Set a timer for deleting a user's data after the user leaves a channel
   

   DelayedRemoveUserFromChannel(channelName, uid, clientSeq);
   

   }
   

   } else if (clientSeq > user.lastClientSeq) {
   

   /*
   

   * If the data for a user already exists, compare the clientSeq
   

   * of the latest notification with that of the last notification
   

   * callback handled by your server. If the latest value is greater,
   

   * update the user data; otherwise, ignore the notification callback.
   

   */
   

   user.role = roleInNotice;
   

   user.isOnline = isOnlineInNotice;
   

   user.lastClientSeq = clientSeq;
   

   
   

   if (isQuit) {
   

   // Mark the status of a user as offline, and delete the user after one minute
   

   System.out.println("User " + uid + " quit channel " + channelName);
   

   DelayedRemoveUserFromChannel(channelName, uid, clientSeq);
   

   }
   

   }
   

   }
   

   
   

   // Set a timer for deleting the data of an offline user
   

   private void DelayedRemoveUserFromChannel(final String channelName, final int uid, final long clientSeq) {
   

   timer.schedule(new TimerTask() {
   

   @Override
   

   public void run() {
   

   Channel channel = channels.get(channelName);
   

   if (channel == null) return;
   

   User user = channel.users.get(uid);
   

   if (user == null) return;
   

   
   

   // If the value in the clientSeq field changes, do not delete data
   

   if (user.lastClientSeq != clientSeq) return;
   

   
   

   if (!user.isOnline) {
   

   // Delete user data only when the user is offline
   

   channel.users.remove(uid);
   

   System.out.println("Removed user " + uid + " from channel " + channelName);
   

   } else {
   

   System.out.println("User " + uid + " is online while delayed removing, cancelled");
   

   }
   

   
   

   // If there are no users left in the channel, delete the channel
   

   if (channel.users.isEmpty()) {
   

   channels.remove(channelName);
   

   System.out.println("Removed channel " + channelName);
   

   }
   

   }
   

   }, WAIT_TIMEOUT_MS);
   

   }
   

   
   

   // Determine whether a user is online.
   

   private static boolean IsUserOnlineInNotice(int eventType) {
   

   return eventType == EVENT_BROADCASTER_JOIN ||
   

   eventType == EVENT_AUDIENCE_JOIN ||
   

   eventType == EVENT_CHANGE_ROLE_TO_BROADCASTER ||
   

   eventType == EVENT_CHANGE_ROLE_TO_AUDIENCE;
   

   }
   

   
   

   // Get the user role.
   

   private static int GetUserRoleInNotice(int eventType) {
   

   if (eventType == EVENT_BROADCASTER_JOIN ||
   

   eventType == EVENT_BROADCASTER_QUIT ||
   

   eventType == EVENT_CHANGE_ROLE_TO_BROADCASTER) {
   

   return ROLE_BROADCASTER;
   

   } else {
   

   return ROLE_AUDIENCE;
   

   }
   

   }
   

   }
   

2. Instantiate the UserRegistry class

   Add the following code to the Handlers class after public class Handlers :

   public static UserRegistry userRegistry = new UserRegistry();
   

3. To update the user registry when you receive a Notifications callback, add the following code to the handle method in the NcsHandler class after os.close();:

   // Maintain user registry
   

   userRegistry.HandleNcsEvent(channelName, uid, eventType, clientSeq);
   

When adopting the solutions recommended by Agora to maintain user online status, you need to recognize the following:

• The solutions only guarantee eventual consistency of user status.
• To improve accuracy, notification callbacks specific to one channel must be handled in a single process.

This section contains in depth information about Notifications.

The header of notification callbacks contains the following fields:

Field name	Value
Content-Type	application/json
Agora-Signature	The signature generated by Agora using the Secret and the HMAC/SHA1 algorithm. You need to use the Secret and HMAC/SHA1 algorithm to verify the signature value. For details, see Signature verification.
Agora-Signature-V2	The signature generated by Agora using the Secret and the HMAC/SHA256 algorithm. You need to use the Secret and the HMAC/SHA256 algorithm to verify the signature value. For details, see Signature verification.

The request body of notification callbacks contains the following fields:

Field name	Type	Description
noticeId	String	The notification ID, identifying the notification callback when the event occurs.
productId	Number	The product ID: 1: Realtime Communication (RTC) service 3: Cloud Recording 4: Media Pull 5: Media Push
eventType	Number	The type of event being notified. For details, see event types.
notifyMs	Number	The Unix timestamp (ms) when Notifications sends a callback to your server. This value is updated when Notifications resends the notification callback.
payload	JSON Object	The content of the event being notified. The payload varies with event type.

{

"noticeId":"2000001428:4330:107",

"productId":1,

"eventType":101,

"notifyMs":1611566412672,

"payload":{

...

}

}

The Agora Notifications server notifies your server of the following RTC channel event types when you use the RTC service:

eventType	Event name	Description
101	channel create	Initializes the channel.
102	channel destroy	Destroys the channel.
103	broadcaster join channel	In the streaming profile, the host joins the channel.
104	broadcaster leave channel	In the streaming profile, the host leaves the channel.
105	audience join channel	In the streaming profile, an audience member joins the channel.
106	audience leave channel	In the streaming profile, an audience member leaves the channel.
107	user join channel with communication mode	In the communication profile, a user joins the channel.
108	user leave channel with communication mode	In the communication profile, a user leaves the channel.
111	client role change to broadcaster	In the communication profile in RTC v4. x products or in the streaming profile, an audience member switches their user role to host.
112	client role change to audience	In the communication profile in RTC v4. x products or in the streaming profile, a host switches their user role to audience member.

This event type indicates that a channel is initialized (when the first user joins the channel). The payload contains the following fields:

Field name	Type	Description
channelName	String	The name of the channel.
ts	Number	The Unix timestamp (s) when the event occurs on the Agora RTC server.

{

"channelName":"test_webhook",

"ts":1560399999

}

This event type indicates that the last user in the channel leaves the channel and the channel is destroyed. The payload contains the following fields:

Field name	Type	Description
channelName	String	The name of the channel.
ts	Number	The Unix timestamp (s) when the event occurs on the Agora RTC server.

{

"channelName":"test_webhook",

"ts":1560399999

}

This event type indicates that a host joins the channel in the streaming profile. The payload contains the following fields:

Field name	Type	Description
channelName	String	The name of the channel.
uid	Number	The user ID of the host in the channel.
platform	Number	The platform type of the host's device: 1: Android 2: iOS 5: Windows 6: Linux 7: Web 8: macOS 0: Other platform
clientType	Number	The type of services used by the host on Linux. Common return values include: 3: On-premise Recording 10: Cloud Recording This field is only returned when platform is 6.
clientSeq	Number	The sequence number, which is used to identify the order in which events occur on the app client. You can use the value of this field to sort the events of a user into chronological order.
ts	Number	The Unix timestamp (s) when the event occurs on the Agora RTC server.

{

"channelName":"test_webhook",

"uid":12121212,

"platform":1,

"clientSeq":1625051030746,

"ts":1560396843

}

This event type indicates that a host leaves the channel in the streaming profile. The payload contains the following fields:

Field name	Type	Description
channelName	String	The name of the channel.
uid	Number	The user ID of the host in the channel.
platform	Number	The platform type of the host's device: 1: Android 2: iOS 5: Windows 6: Linux 7: Web 8: macOS 0: Other platform
clientType	Number	The type of services used by the host on Linux. Common return values include: 3: On-premise Recording 10: Cloud Recording This field is only returned when platform is 6.
clientSeq	Number	The sequence number, which is used to identify the order in which events occur on the app client. You can use the value of this field to sort the events of a user into chronological order.
reason	Number	The reason why the host leaves the channel: 1: The host quits the call. 2: The connection between the app client and the Agora RTC server times out, which occurs when the Agora SD-RTN does not receive any data packets from the app client for more than 10 seconds. 3: Permission issues. For example, the host is kicked out of the channel by the administrator through the Banning user privileges RESTful API. 4: Internal issues with the Agora RTC server. For example, the Agora RTC server disconnects from the app client for a short period of time for load balancing. When the load balancing is finished, the Agora RTC server reconnects with the client. 5: The host uses a new device to join the channel, which forces the old device to leave the channel. 9: The app client has multiple IP addresses, therefore the SDK actively disconnects from the Agora RTC server and reconnects. The user is not aware of this process. Check whether the app client has multiple public IP addresses or uses a VPN 10: Due to network connection issues, for example, the SDK does not receive any data packets from the Agora RTC server for more than 4 seconds or the socket connection error occurs, the SDK actively disconnects from the Agora server and reconnects. The user is not aware of this process. Check the network connection status. 999: The user has unusual activities, such as frequent login and logout actions. 60 seconds after receiving the 104 or 106 event callback with reason as 999, your app server needs to call the Banning user privileges API to remove the user from the current channel; otherwise, your server could fail to receive any notification callbacks about the user's events if the user rejoins the channel. 0: Other reasons.
ts	Number	The Unix timestamp (s) when the event occurs on the Agora RTC server.
duration	Number	The length of time (s) that the host stays in the channel.

{

"channelName":"test_webhook",

"uid":12121212,

"platform":1,

"clientSeq":1625051030789,

"reason":1,

"ts":1560396943,

"duration":600

}

This event type indicates that an audience member joins the channel in the streaming profile The payload includes the following fields:

Field name	Type	Description
channelName	String	The name of the channel.
uid	Number	The user ID of the audience member in the channel.
platform	Number	The platform type of the audience member's device: 1: Android 2: iOS 5: Windows 6: Linux 7: Web 8: macOS 0: Other platform
clientType	Number	The type of services used by the host on Linux. Common return values include: 3: On-premise Recording 10: Cloud Recording This field is only returned when platform is 6.
clientSeq	Number	The sequence number, which is used to identify the order in which events occur on the app client. You can use the value of this field to sort the events of a user into chronological order.
ts	Number	The Unix timestamp (s) when the event occurs on the Agora RTC server.

{

"channelName":"test_webhook",

"uid":12121212,

"platform":1,

"clientSeq":1625051035346,

"ts":1560396843

}

This event type indicates that an audience member leaves the channel in the streaming profile. The payload includes the following fields:

Field name	Type	Description
channelName	String	The name of the channel.
uid	Number	The user ID of the audience member in the channel.
platform	Number	The platform type of the audience member's device: 1: Android 2: iOS 5: Windows 6: Linux 7: Web 8: macOS 0: Other platform
clientType	Number	The type of services used by the audience member on Linux. Common return values include: 3: On-premise Recording 10: Cloud Recording This field is only returned when platform is 6.
clientSeq	Number	The sequence number, which is used to identify the order in which events occur on the app client. You can use the value of this field to sort the events of a user into chronological order.
reason	Number	The reason why the audience member leaves the channel: 1: The audience member quits the call. 2: The connection between the app client and the Agora RTC server times out, which occurs when the Agora SD-RTN does not receive any data packets from the app client for more than 10 seconds. 3: Permission issues. For example, the audience member is kicked out of the channel by the administrator through the Banning user privileges RESTful API. 4: Internal issues with the Agora RTC server. For example, the Agora RTC server disconnects from the app client for a short period of time for load balancing. When the load balancing is finished, the Agora RTC server reconnects with the client. 5: The audience member uses a new device to join the channel, which forces the old device to leave the channel. 9: The app client has multiple IP addresses, therefore the SDK actively disconnects from the Agora RTC server and reconnects. The user is not aware of this process. Check whether the app client has multiple public IP addresses or uses a VPN 10: Due to network connection issues, for example, the SDK does not receive any data packets from the Agora RTC server for more than 4 seconds or the socket connection error occurs, the SDK actively disconnects from the Agora server and reconnects. The user is not aware of this process. Check the network connection status. 999: The user has unusual activities, such as frequent login and logout actions. 60 seconds after receiving the 104 or 106 event callback with reason as 999, your app server needs to call the Banning user privileges API to remove the user from the current channel; otherwise, your server could fail to receive any notification callbacks about the user's events if the user rejoins the channel. 0: Other reasons.
ts	Number	The Unix timestamp (s) when the event occurs on the Agora RTC server.
duration	Number	The length of time (s) that the audience member stays in the channel.

{

"channelName":"test_webhook",

"uid":12121212,

"platform":1,

"clientSeq":1625051035390,

"reason":1,

"ts":1560396943,

"duration":600

}

This event type indicates that a user joins the channel in the communication profile. The payload includes the following fields:

Field name	Type	Description
channelName	String	The name of the channel.
uid	Number	The user ID of the user in the channel.
platform	Number	The platform type of the host's device: 1: Android 2: iOS 5: Windows 6: Linux 7: Web 8: macOS 0: Other platform
clientSeq	Number	The sequence number, which is used to identify the order in which events occur on the app client. You can use the value of this field to sort the events of a user into chronological order.
ts	Number	The Unix timestamp (s) when the event occurs on the Agora RTC server.

{

"channelName":"test_webhook",

"uid":12121212,

"platform":1,

"clientSeq":1625051035369,

"ts":1560396834

}

This event type indicates that a user leaves the channel in the communication profile. The payload includes the following fields:

Field name	Type	Description
channelName	String	The name of the channel.
uid	Number	The user ID of the user in the channel.
platform	Number	The platform type of the user's device: 1: Android 2: iOS 5: Windows 6: Linux 7: Web 8: macOS 0: Other platform
clientSeq	Number	The sequence number, which is used to identify the order in which events occur on the app client. You can use the value of this field to sort the events of a user into chronological order.
reason	Number	The reason why a user leaves the channel: 1: The user quits the call. 2: The connection between the app client and the Agora RTC server times out, which occurs when the Agora SD-RTN does not receive any data packets from the app client for more than 10 seconds. 3: Permission issues. For example, the user is kicked out of the channel by the administrator through the Banning user privileges RESTful API. 4: Internal issues with the Agora RTC server. For example, the Agora RTC server disconnects from the app client for a short period of time for load balancing. When the load balancing is finished, the Agora RTC server reconnects with the client. 5: The user uses a new device to join the channel, which forces the old device to leave the channel. 9: The app client has multiple IP addresses, therefore the SDK actively disconnects from the Agora RTC server and reconnects. The user is not aware of this process. Check whether the app client has multiple public IP addresses or uses a VPN 10: Due to network connection issues, for example, the SDK does not receive any data packets from the Agora RTC server for more than 4 seconds or the socket connection error occurs, the SDK actively disconnects from the Agora server and reconnects. The user is not aware of this process. Check the network connection status. 999: The user has unusual activities, such as frequent login and logout actions. 60 seconds after receiving the 104 or 106 event callback with reason as 999, your app server needs to call the Banning user privileges API to remove the user from the current channel; otherwise, your server could fail to receive any notification callbacks about the user's events if the user rejoins the channel. 0: Other reasons.
ts	Number	The Unix timestamp (s) when the event occurs on the Agora RTC server.
duration	Number	The length of time (s) that the user stays in the channel.

{

"channelName":"test_webhook",

"uid":12121212,

"platform":1,

"clientSeq":1625051037369,

"reason":1,

"ts":1560496834,

"duration":600

}

This event type indicates that an audience member calls setClientRole to switch their user role to host in the streaming profile. The payload includes the following fields:

Field name	Type	Description
channelName	String	The name of the channel.
uid	Number	The user ID of the user in the channel.
clientSeq	Number	The sequence number, which is used to identify the order in which events occur on the app client. You can use the value of this field to sort the events of a user into chronological order.
ts	Number	The Unix timestamp (s) when the event occurs on the Agora RTC server.

{

"channelName":"test_webhook",

"uid":12121212,

"clientSeq":1625051035469,

"ts":1560396834

}

This event type indicates that a host call setClientRole to switch their user role to audience member in the streaming profile. The payload contains the following fields:

Field name	Type	Description
channelName	String	The name of the channel.
uid	Number	The user ID of the user in the channel.
clientSeq	Number	The sequence number, which is used to identify the order in which events occur on the app client. You can use the value of this field to sort the events of a user into chronological order.
ts	Number	The Unix timestamp (s) when the event occurs on the Agora RTC server.

{

"channelName":"test_webhook",

"uid":12121212,

"clientSeq":16250510358369,

"ts":1560496834

}

If your server that receives notification callbacks is behind a firewall, you need to call the IP address query API to retrieve the IP addresses of Notifications and configure your firewall to trust all these IP addresses.

Agora occasionally adjusts the Notifications IP addresses. Best practice is to call this endpoint at least every 24 hours and automatically update the firewall configuration.

• Method: GET
• Endpoint: https://api.agora.io/v2/ncs/ip

Authorization: You must generate a Base64-encoded credential with the Customer ID and Customer Secret provided by Agora, and then pass the credential to the Authorization field in the HTTP request header.

This API has no body parameters.

When the request succeeds, the response body looks like the following:

{

"data": {

"service": {

"hosts": [

{

"primaryIP": "xxx.xxx.xxx.xxx"

},

{

"primaryIP": "xxx.xxx.xxx.xxx"

}

]

}

}

}

Each primary IP field shows an IP address of Notifications server. When you receive a response, you need to note the primary IP fields and add all these IP addresses to your firewall's allowed IP list.

• Notifications does not guarantee that notification callbacks arrive at your server in the same order as events occur.
• Your server needs to be able to handle messages arriving out of order.
• To improve the reliability of Notifications, there can be more than one notification callback for each event, and your server needs to be able to handle repeated messages.