How to Configure 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

How to recognise if I'm using Vonage Video API Unified Environment or Vonage Video API OpenTok environment?

Procedure

for Vonage Video API OpenTok environment

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 Vonage Video API 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 Configure Callback URL.
6. Configure the callback URL and click Submit.
   
7. A popup with "Callback URL Configured" will appear if the callback is successfully registered.
   
8. If the registered callback URL cannot be reached, a popup with "Configuration Failed" will appear. Double-check your callback URL and the server hosting the URL and retry.
   

To remove the registered callback:

1. Under Archiving, click Remove.
   
2. Click Confirm Removal to remove the configured archive monitoring callback.
   

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.

Procedure for Vonage Video API Unified Environment

To register a callback:

1. Log in to your Vonage Unified API Account.
2. From the left menu, click on Applications.
3. Click on the Video Enabled Application for which you want to register a session monitoring callback.
4. Click Edit.
5. Under Archiving, click Configure Callback URL. (This URL will be pinged when a new archive is created. See our developer docs for more info.)
6. Configure the callback URL and and click "Save" on the lower right.
   
   
   

To remove the registered callback follow the same steps above but empty the form field then click "Save"

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.