How to configure the Session Monitoring Callbacks

Objective

Configuring the session monitoring callbacks to receive real-time session events for your Vonage Video API projects and monitor your session activity from your app server.

Applies To

  • Vonage Video API
  • Projects
  • Session Monitoring

Procedure

Session monitoring callback URL can be configured within the account portal. Whenever a Session event is detected, i.e., Connection is created or destroyed; Stream is created or destroyed, a HTTP POST request is issued from the OpenTok infrastructure to your registered callback URL. 

Callback URL can be configured by the registered Admin or Developer of your 
Vonage
Video API account.

To register a callback:

  1. Log in to your Vonage Video API Account.
  2. From the left menu, choose the desired Account.
  3. Select a Project for which you want to register a session monitoring callback.
  4. Scroll down to Project Settings.
  5. Under Session Monitoring, click on the button.
  6. Configure the callback URL and submit. 

           mceclip2.png

     7. A popup with "callback URL configured" will appear if the callback is successfully registered.

             Screenshot_2021-10-02_at_1.16.38_PM.png

     8. If the registered callback URL cannot be reached, a popup with "Configuration failure" will appear. Kindly double-check your callback URL and the server hosting the URL and Retry.

             Screenshot_2021-10-02_at_1.23.05_PM.png

To remove the registered callback:

  1. Under Session Monitoring, click on the Remove option.

       mceclip0.png

       2. Click on the Confirm Removal to remove the configured session monitoring callback.

             mceclip1.png

Additional Information

For additional information about Session monitoring, see our developer documentation on Session Monitoring.

Have more questions? Submit a request