Subscribing to webinar webhooks and events

Like other RingCentral products, events are often emitted by the platform to signal to developers and their applications about key events that have been triggered by a user. Developers should be aware that while there exist many similarities between how one might create and receive a webinar event, and any other event on the platform, there are two distinct interfaces a develope must engage with. In other words, webinar has its own unique set of API endpoints for subscribing to events emitted by the webinar platform.

Subscribing to a webinar webhook

To subscribe to a webinar webhook, one will call the create subscription operation while specifying the list of events to subscribe to via the eventFilters parameter, along with the subscription's expiration date and any other pertinent configuration details. The following code sample shows how to create a webinar webhook subscription.

const RC = require('@ringcentral/sdk').SDK

var rcsdk = new RC({
    'server':       process.env.RC_SERVER_URL,
    'clientId':     process.env.RC_APP_CLIENT_ID,
    'clientSecret': process.env.RC_APP_CLIENT_SECRET
});
var platform = rcsdk.platform();
platform.login({ 'jwt':  process.env.RC_USER_JWT })

platform.on(platform.events.loginSuccess, function(e){
    subscribe_to_webinar_webhook()
});

async function subscribe_to_webinar_webhook(){
    try {
    console.log('fetching preference...')
    var webinarId   = '<INSERT WEBINAR ID>'
    var eventFilter = '/webinar/configuration/v1/company/sessions?webinarId=' + webinarId
    var webhookUrl  = 'https://acme.com/app/webhooks'
    var endpoint    = '/webinar/notifications/v1/subscriptions'
    platform.post(endpoint, {
        "eventFilters": [
        eventFilter
        ],
        "deliveryMode": {
        "transportType": "WebHook",
        "address": webhookUrl
        },
        "expiresIn": 100000
    })
        .then(function(resp) {
          return resp.json()
        })
        .then(function (json) {
            console.log('Response: ', json )
        });
    } catch(e) {
        console.log("An error occured: ", e.message)
        process.exit(1)
    }
});

Available event filters

The following is a list of all currently available webhooks that a developer can subscribe to. Developers can subscribe to multiple events in a single subscription request by specifying mutiple event filters in their request.

Event filter parameters

All of the above event filters can be further refined to subscribe to a more precise subset of events from an account that a developer might be interested in. For example, if a developer subscibes to the .../company/sessions/registrants filter then the developer will receive all events for all webinar sessions in their account. If however, they only wish to receive events pertaining to a specific webinar, then they can specify the webinarId in the event filters parameters:

/webinar/registration/v1/company/sessions/registrants?webinarId=<INSERT WEBINAR ID>

The following filter parameters are supported: