Zoom Outbound Integration
  • 28 Jul 2023
  • 5 Minutes to read
  • Dark
    Light
  • PDF

Zoom Outbound Integration

  • Dark
    Light
  • PDF

Article summary

In this guide, we will set up a Zoom Outbound Integration that triggers a Zoom meeting in response to incoming alerts received by AlertOps.

Zoom Configuration

To get started, create a Zoom Developer account. You must have a Zoom Video SDK account to build with the Video SDK.

  1. To create a Zoom Video SDK account, go to Video SDK, click Buy Now, and follow the steps to create your account.
  2. When you create a Zoom Video SDK account, you'll automatically get a free trial to start building with the Video SDK.
  3. To get Video SDK credentials, go to the Zoom App Marketplace and sign in with your Zoom Video SDK account.
  4. Click Develop and choose Build App
  5. From the selection of Video SDK app types, select Server-to-Server OAuth and click Create.
  6. Name your Zoom Application.
  7. Add Scopes for your application. In this example, the following scopes were used:
    • meeting:master 
    • meeting:write:admin 
    • user:write:admin
  8. After completing the Video SDK app setup and activating your app, go to App Credentials to find your Video SDK credentials. These will be used for Authorization in the next steps. 


AlertOps Configuration

Now that we have completed the integration set up in Zoom, we need to make some changes in our AlertOps environment to prepare for the integration.

Add Custom Fields

In AlertOps, a Template is used to create custom attributes.  In most cases, where only a small number of Attributes are created, extending the Standard Template is sufficient, though you can create a new one if you choose.  

In order to capture fields from the Zoom Outbound Integration JSON data, add a custom attributes for the following:

NameData Type
access_tokenLongString
join_urlLongString


Outbound Integration Configuration

To create the outbound integration in AlertOps:

  1. Click Configuration on the main menu and select Integrations menu.
  2. In the Outbound Integrations section, click the Add Outbound button.
  3. Name the Outbound Integration, in this example we have named it Zoom Outbound Integration.
  4. Click the Submit button to save.


Create Methods

Once your integration has been created, we need to add some Methods that will trigger when this integration is used in a Workflow.

Create Zoom Access Token Method

This method is going to generate an API call to procure an access token for our Zoom app.

  1. From the Zoom Outbound Integration page, scroll down to the Methods section and click the Add Method button.
  2. Name this Method Create Zoom Access Token Method.
  3. For Type, select REST. For Alert Type select Standard Alert, and set Request and Response Type as JSON.
  4. Select POST for the Request Method.
  5. Input the following for the URI, but edit it to include your Zoom App Account ID:
    https://zoom.us/oauth/token?grant_type=account_credentials&account_id=YourZoomAppAccountID
  6. Check the Update Alert Fields box.
  7. Input the following into the Response Data box. NOTE: the variable for "<<Attribute.access_token>>"must exactly match the name saved for the custom attribute. You can easily do this by dragging and dropping the value from the Available Fields column on the left.
    {"access_token":"<<Attribute.access_token>>","token_type":"bearer","expires_in":3599,"scope":"user:write:admin meeting:write:admin meeting:master"}
  8. Finally, add an Authorization Header, edited with the Base64 clientID:clientSecret from your Zoom App.
    Authorization: Basic Base64Encoder(clientId:clientSecret)


Create a Meeting Method

This method is going to generate an API call to create a Zoom Meeting.

  1. From the Zoom Outbound Integration page, scroll down to the Methods section and click the Add Method button.
  2. Name this Method Create a Zoom Meeting.
  3. For Type, select REST. For Alert Type select Standard Alert, and set Request and Response Type as JSON.
  4. Select POST for the Request Method.
  5. Input the following for the URI, but edit to include your Zoom App Account ID:
    https://zoom.us/v2/users/yourZoomUserId/meetings
  6. Input the following into the Request Data box and edit to include your Zoom user id. Click Submit to save.
    {"agenda":"Meeting in response to alert","pre_schedule":false,"schedule_for":"yourZoomUserID","type":1}


Update Create Meeting Header Method

This method is going to update the headers for the Create a Zoom Meeting Method to include the value for the access token.

  1. From the Zoom Outbound Integration page, scroll down to the Methods section and click the Add Method button.
  2. Name this Method Update Create Meeting Header Method.
  3. For Type, select REST. For Alert Type select Standard Alert, and set Request and Response Type as JSON.
  4. Select PUT for the Request Method.
  5. Check the Update Alert Fields box.
  6. Input the following for the URI, but edit to include the Zoom Outbound Integration ID and Method ID for the Create a Zoom Meeting Method.
    https://api.alertops.com/api/v2/integrations/outbound/IntegrationID/methods/MethodID

    Note: The values for Integration ID(shown below underlined blue) and Method ID(shown below underlined red) can be found in the URL for the Create a Zoom Meeting Method in AlertOps. 
  7. Input the following into the Request Data box, edited to include your Zoom User ID. 
    {"method_name":"Create a Zoom Meeting","is_used":true,"method_type":{"type":"REST","uri":"https://zoom.us/v2/users/yourZoomUserID/meetings","request_type":"JSON","web_method":"POST","response_data_type":"JSON","request_data":"{\"agenda\":\"Meeting in response to alert\",\"pre_schedule\":false,\"schedule_for\":\"yourZoomUserID\",\"type\":1}","response_data":"","headers":"{\"Authorization\":\"Bearer <<Attribute.access_token>>\"}"},"alert_type":232,"alert_type_name":"Standard Alert","update_alert_fields":true}

  8. Finally, add the following Header, edited to include your AlertOps User API key which can be found in your AlertOps user profile.
    api-key: yourAlertOpsUserAPIKey


Create Workflows

Now that the methods have been created, we need to create two Workflows to trigger the methods based on an Alert's Escalation Policy.

Create Token and Update Method Workflow

  1. Click Configuration on the main menu and select Workflows from the dropdown menu.
  2. From the Workflows page, click the Add Workflow button.
  3. For Type, select Alert.
  4. Name the Workflow. In this example we have named the workflow Create Zoom Access Token and Update Method Workflow.
  5. For Alert Type, select Standard Alert
  6. Click the Submit button to save.

Start Conditions

  1. Under the Start Conditions section, click the Add button for Match All Conditions.
  2. Select the TimeFromBeginning(Minutes) condition.
  3. Set 'is' as the operator, and '0' as the value.
  4. Click the green checkmark to save this condition.

Actions

For this Workflow we will be adding two Actions:

  1. Under the Actions section, click the Add Action button.
  2. For Action select Outbound Service Notification.
  3. For the Web Method select Zoom Outbound Integration - Create Zoom Access Token Method
  4. Click Submit to save.

Once saved, click the Add Action button again.

  1. For Action select Outbound Service Notification.
  2. For the Web Method select Zoom Outbound Integration - Update Create Meeting Header Method
  3. Click Submit to save.


Create Meeting Workflow

Start Conditions

Actions


Escalation Policy

Once the Workflows have been created, they can be associated with an Escalation Policy to be used to guide Alerts.

  1. Click Configuration on the main menu and select Escalation Policies from the dropdown menu.
  2. From the Escalation Policies page, select an Escalation.
  3. From the Escalation detail page, expand the Automation tab.
  4. On the right, click the Add Workflow button.
  5. Check the box next to the workflows we just created and use the right arrow to move them to Selected Workflows.
  6. Click Submit to save.

Now that the workflows have been associated with this Escalation Policy, they will trigger methods according to the escalation rules.



Was this article helpful?

What's Next