How to configure the Archive Monitoring Callbacks

Objective

Configuring the archive monitoring callbacks to receive notifications when an archive's status changes.

Applies To

  • Vonage Video API
  • Projects
  • Archive Monitoring

Procedure

Archive monitoring callback URL can be configured within the account portal. Each archive goes through multiple states throughout the lifespan of the archive. For every status update that occurs, a HTTP POST request is issued from the OpenTok infrastructure to your registered callback URL. This is particularly useful for triggering the post-processing of an archive or performing any necessary administrative tasks after an archive has been uploaded to persistent storage.

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 Archiving, click on the Screenshot_2021-10-02_at_9.31.59_AM.pngbutton.
  6. Configure the callback URL and submit. 

     Screenshot_2021-10-02_at_9.48.09_AM.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 Archiving, click on the Remove option.

     mceclip0.png

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

         mceclip1.png

Additional Information

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

For more details about Archive status changes, see our developer documentation on archives status change.

Have more questions? Submit a request