Zoom Webhook
Through Pathfix Automation, you can enable user webhook listening for all your user that have connected their Zoom account via Pathfix OAuth.
The following documentation will guide you on how you can setup your Zoom account and setup Zoom Webhook listening for all your connected users.
Before proceeding, make sure you have setup your Zoom integration in Pathfix OAuth and have added the Connect button for your users to be able to connect their Zoom accounts.
- Configure your Zoom integration in Pathfix OAuth
- Make sure you have included one or more of the following scopes in your Zoom Developer app: user:write:admin, user:read:admin, user:read, user:write, user_info:read, user_profile
- Add the script tag in your application to allow your users to authenticate their Zoom accounts (Detailed documentation for Pathfix OAuth can be found here)
- Create a blank automation by clicking on Design and selecting New Design
- Give your first task a name to save the automation (autosave)
- Click on the Test and Publish tab and click on Test to run a test on the automation
- On successful completion, click on Publish to Live
- Click on Endpoints and copy the endpoint url for use in the Webhook setup
- Live Endpoint is for Live environments and Dev endpoint is for testing/development
- Click on Webhooks from the top navigation and click on Create New
- Select Zoom from the list of provider webhooks
- Paste the endpoint URL copied from the automation into the Callback URL section
- Select the app and click on Features on the left menu options
- Copy the Secret Token for use in your webhook
- Paste the Secret Token in the Secret Token section of the webhook setup in Pathfix Automation
- Generate your Webhook URI by clicking on the Webhook URI section. Copy the generated URI for use in Zoom later
- Click on Save and save the settings
- On the Webhooks page, click on Activate against Zoom to activate your webhook
- The webhook activation will take a few minutes and will happen in the background (click on Refresh on the top navigation to refresh the page)
- Once activated, the webhook status will turn Green
In order to complete your ZoomWebhook setup, you will need to add the Callback URL generated by the Pathfix Automation webhook for it to start sending the evenet data
- Scroll down to the General Features section and enable Event Subscriptions function
- Click on Add Event Subscription
- Add a name for the subscription
- Paste the endpoint copied over from the Zoom webhook setup in Pathfix Automation
- Click on Validate button to validate if the webhook is listening for events being sent by Zoom
- Under Add Events, select the events that you want the webhook to listen for
- Click Save to save the settings
We recommend running a test on your webhook setup to make sure the setup is right. To do this:
- Go to your Pathfix OAuth account and click on Test Connection for Zoom
- Click on Connect/Re-Connect and connect a Zoom account
- On successful connection, the Automation will start listening for changes in Zoom for the connected user
- You will see the webhook user count increase (if it doesnt increase at first, click on Refresh on the top navigation)
- Go to your Zoom app and create a test entry
- Go to your Pathfix Automation account and click on Monitor
- You should see the test event created would have triggered a webhook call
Your Test is successful.
Now that your webhook has been setup successfully, you will need to copy the payload sent by Zoom and captured by Pathfix Automation to create your Automation.
Here are the few initial steps to get you going:
- Copy the Request received from our test event
- Go to the Automation created and paste the Request into the Call data (JSON) section of the first task
- From here, you can build out your automation the way you want
- Click on the + icon to add a task and you can call an API, run a condition or process the data as you please through the Automation
Important
- Any changes made to the automation can only be done in the Dev environment
- Once changes are made, you will first have to Test the Automation and on successful completion, Publish to Live
- Please note, without publishing to Live, the changes will not go into effect
Few points to note on the JSON:
- The pathfix_user_id is the same user Id that is sent via the Pathfix OAuth system. This generally is the Current Users Unique Id
- the data section of the JSON is the exact data that is sent by the provider
Need help? Reach out to our support via [email protected] or live chat through your Pathfix dashboard