Skip to main content

Zoom Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a Zoom location.
zoom_api.png

Zoom

Create a Zoom Destination​

  1. Click the + icon on the Nexset that will be sent to the Zoom destination, and select the Send to Destination option from the menu.

  2. Select the Zoom connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Zoom organization, and click Next; or, create a new Zoom credential for use in this flow.

  3. In Nexla, Zoom destinations can be created using pre-built endpoint templates, which expedite destination setup for common Zoom endpoints. Each template is designed specifically for the corresponding Zoom endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Zoom destinations can also be configured manually, allowing you to send data to Zoom endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Zoom endpoints. Each template is designed specifically for the corresponding Zoom endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Add Meeting Registrants

    This endpoint registers participants for a Zoom meeting. Use this template when you need to automatically add registrants to scheduled meetings based on data from your Nexla flows.

    • Enter the Meeting ID in the Meeting ID field. This is the unique identifier for the Zoom meeting where you want to add registrants. You can find this ID in your Zoom account or by using the "Get User's Meetings" source endpoint.
    • The endpoint will automatically send participant data from your Nexset to the Zoom meeting registration system.
    • Each record in your Nexset will be processed as a separate registrant, allowing you to bulk-register multiple participants at once.

    Meeting IDs are unique identifiers that can be obtained from your Zoom account or by using Zoom's API to list meetings. Ensure you have the correct Meeting ID before configuring this endpoint. For complete information about meeting registrant management, see the Zoom API Documentation.

    Update Phone Blocked List

    This endpoint updates Zoom's phone blocked list to manage which phone numbers are blocked from calling into Zoom meetings. Use this template when you need to automatically manage blocked phone numbers based on data from your Nexla flows.

    • Enter the Block List ID in the Block List ID field. This is the unique identifier for the phone blocked list you want to update. You can find this ID in your Zoom account settings under Phone Management.
    • The endpoint will automatically send phone number data from your Nexset to update the blocked list.
    • Each record in your Nexset will be processed to update the blocked list configuration, allowing you to bulk-manage blocked phone numbers.

    Block List IDs are unique identifiers that can be found in your Zoom account's Phone Management settings. Ensure you have the correct Block List ID before configuring this endpoint. For complete information about phone blocked list management, see the Zoom API Documentation.

Configure Manually​

Zoom destinations can be manually configured to send data to any valid Zoom API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Zoom API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Zoom API from the Method pulldown menu. The most common methods for Zoom destinations are:

    • POST: For creating new resources (most common for Zoom destinations)
    • PUT: For updating existing resources
    • PATCH: For partial updates to existing resources
    • DELETE: For removing resources

Data Format​

  1. Select the format in which the Nexset data will be sent to the Zoom API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call.

Zoom APIs typically expect JSON format for most operations. Choose JSON unless you have specific requirements for other formats like XML or form data.

API Endpoint URL​

  1. Enter the URL of the Zoom API endpoint to which you want to send the Nexset data in the URL field. For update/upsert operations, include the ID of the object to be updated at the end of the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Request Headers​

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration.

Exclude Attributes from the Call​

  • If any record attributes in the Nexset should be omitted when sending data to this Zoom destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Record batching is particularly useful for Zoom destinations when you need to process large numbers of registrants or phone numbers efficiently. Batching can help reduce API calls and improve performance.

Response Webhook​

Nexla can automatically send the response received from the Zoom API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Response webhooks are particularly useful for Zoom destinations to track meeting registration status, phone list updates, and any error responses from the Zoom API.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Zoom API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Zoom API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Zoom API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Zoom endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to the Zoom endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.