Configure a Zoom webinar integration

Who can use this feature?

A Zoom webinar integration with Totango allows you to automatically record user-level registration and attendance dates from Zoom. You can also view webinar registration and attendance activity in Totango as usage data (module/activity).

Although this is the most common use case, this integration allows you to turn off the automatic attribute creation and/or usage level data. See more configuration options.

Requirements

Considerations

  • When the integration is enabled, all webinars under your Zoom account are included; you cannot exclude certain webinar events.
  • The integration excludes tracking activity for participants that have email addresses in your domain (i.e., doesn't track your internal/employee activity).
  • If a registrant or attendee of a webinar does not have an email address already in Totango, the default behavior skips that user. See more configuration options.

Create the integration

The following instructions apply to the most common use case: Capturing events for registration and attendance.

Refer to the optional elements below to explore more configuration options outside of this example.

The endpoint requires* the following. Replace the highlighted items in yellow (in the code below) with your information.

  1. service_id: Your Totango Service ID (e.g., SP_25001_01)
  2. totangoToken: Totango access token (e.g., {v2}690faf9b-2ff0-xxxx-b4dd-2c0119e738ab)
  3. yourDomain: Used to exclude internal users (e.g., awesomecompany.com) 
  4. zoomToken: Refer to the below steps.

*You do not have to specify your domain if you want to track employee / internal webinar activity, but most use cases do not.

To create the integration

  1. In a browser window, go to developers.zoom.us
  2. Sign in with your Zoom credentials for your developer account.

    Step 1: Get token and turn on event subscription
  3. Click Build App (blue button).
  4. In the Webhook Only box, click Create.
  5. Name your app (e.g., “Totango capture Register/Attend”).
  6. When prompted, fill in your company name, name, and email address.
  7. Click Continue.
  8. Copy and save the Verification Token.
  9. Set the Event subscriptions button to On.

    Step 2: Add an event subscription for webinar attendance
  10. Click Add Event Subscription, and name your subscription (e.g., “Webinar Attendance”).
  11. For the event notifications endpoint, paste the following code, making sure to replace the highlighted parts with your own information: 
    http://44.209.217.180:5000/attend?service_id=yourserviceID&totangoToken=yourTotangoToken&yourDomain=domain.com&zoomToken=yourzoomToken
  12. Click Add Events.
  13. Click Webinar.
  14. Select the Participant/Host joined webinar check box.
  15. Click Done, and then click Save.

    Step 3: Add an event subscription for webinar registration
  16. Click Add Event Subscription, and name your subscription (e.g., “Webinar Registration”).
  17. For the event notifications endpoint, paste the following code, making sure to replace the highlighted parts with your own information: 
    http://44.209.217.180:5000/register?service_id=yourserviceID&totangoToken=yourTotangoToken&yourDomain=domain.com&zoomToken=yourzoomToken
  18. Click Add Events.
  19. Click Webinar.
  20. Select the Participant/Host joined webinar check box.
  21. Click Done, and then click Save.
  22. Click Continue.
    You should see a message to indicate that your app is activated on the account

Results of the integration

These are the results in Totango when the default integration is configured (above). These results apply for each webinar you schedule in your Zoom account.

Registration 

  1. Attribute: A new date attribute will be created in Totango at the user level and will be populated with the appropriate date value, per user.
    Example: <Name of webinar>_Registered Date

    You can rename the display name of this attribute in Data Modeler, or you can optionally turn off attribute creation.

  2. Usage: A usage event will be available to view in Totango
    Example: Module = Signals | Action = Register - <Name of webinar>

    You can customize the module name, or you can optionally turn off usage activity.

Attendance

  1. Attribute: A new date attribute will be created in Totango at the user level and will be populated with the appropriate date value, per user.
    Example: <Name of webinar>_Attended Date

    You can rename the display name of this attribute in Data Modeler, or you can optionally turn off attribute creation.

  2. Usage: A usage event will be available to view in Totango
    Example: Module = Signals | Action = Attend - <Name of webinar>

    You can customize the module name, or you can optionally turn off usage activity.

More configuration options

Create domain account

If a webinar participant's email address does not exist in Totango, the default behavior is that the integration skips that participant. Alternatively, you can have the integration create an account using the domain of the user's email.

For example, val@widgetsRus.com would create an account in Totango with the ID widgetsRus.com and a user (val@widgetsRus.com) associated to that account.

To enable the option to create an account for a user that doesn't exist in Totango, add this code to the end of each webhook URL (above):

&root_domainFlag=True

 

Do not create attribute

If you have an event subscription enabled, the default behavior is to automatically create the user attribute in Totango. Alternatively, you can turn off this option to not create a user attribute.

To disable the integration from automatically creating a user date attribute, add this code to the end of each webhook URL (above):

&attributeFlag=False

 

Do not create action / module

If you have an event subscription enabled, the default behavior is to create a user action within Totango (usage data). Alternatively, you can turn off this option to not send an action / module.

To disable the integration from sending usage data, add this code to the end of each webhook URL (above):

&actionModuleFlag=False

 

Customize module name

If you have an event subscription enabled, the default behavior is to create a user action within Totango (usage data) using the default convention for module name (e.g., Signals). Alternatively, you can customize the module name.

Any text string (less than 100 characters) is supported.

To customize the module name, add this code to the end of each webhook URL (above):

&module=<custom name of module>

 

Specify dimension for created attributes

If you have an event subscription enabled, the default behavior is to automatically create the user attribute in Totango under the "General" dimension. Alternatively, you can specify a different dimension under which the attributes will be created.

  • Any text string (less than 100 characters) is supported.
  • If you provide a dimension name that is not already defined in Totango, the custom dimension will not be set on the attribute.
  • If the attribute already exists, If you send a valid custom value for the dimension, Totango will change the existing attribute's dimension to the newly provided value.

To customize the module name, add this code to the end of each webhook URL (above):

&dimension=<name of dimension>

 

Add v2 or bcrypt to your Zoom token

Zoom doesn't allow curly brackets { } within it's outbound web-hooks.  If your token starts with {v2} or {bcrypt} use this flag and paste your token without the {v2} or {bcrypt} at the front.

 

&bcrypt=True

or

&v2=True

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request