[API] Recording notification and webhook
updated 2 months ago
Virtual Classroom API customers can set-up an email notification template to notify when the recording is available and enable webhook to ping your website URL when the recorded file becomes available. This feature is available in your API dashboard.
Once the recording is available, you may want to post-process this information at your end for analytics or dashboard data. For this specific reason, we've also introduced webhooks.
Navigate to the API dashboard
Click on 'More' at the option of the domain which you had created before, and click on "Recording notification".
Select the default tab "Recording Webhook". Now, type the target URL for receiving webhooks and save changes.
Note : Make sure that the URL you have setup is capable of receiving and parsing the posted parameters. For example, PHP files may use filegetcontents('php://input'); to receive parameters posted.
Select tab "Notification" to setup your email notification template. Turn the slide to 'Yes' and save your changes. You can turn off email notification anytime by turning it back to "No" and save the changes.
When you edit the email template, you can see that your account email is populated as the default "To" address. You can change this anytime to a different email address. The template can be easily customized with variables or input your custom text.
Recording webhooks lets you register a URL that we will notify anytime a recorded video is available in your account. API endpoint automatically posts parameters such as '&roomId=123&recordId' as part of the URL so you can process this data further at your end.