Zoom
Connect and Test the Zoom Integrations
This document outlines how users can connect Zoom accounts from the Pyas Dashboard.
For documentation on how to connect Zoom accounts through the Pyas REST API, please refer to this part of our API reference.
In order to make integrating with Zoom easier, end-users and developers can use our Zoom for Pyas app. Below are the steps for adding the Zoom for Pyas app, usage, and removing/revoking the Zoom for Pyas app.
This guide assumes you already have at least one Pyas App created in your Pyas Dashboard. If you don't have any apps created, see this guide on Creating an App.
Adding the App
Login to the Pyas dashboard: https://www.app.pyas.io/auth/login.
Click on Apps in the left menu bar.
Click on the app that you want to connect the Zoom account to.
Under the Accounts tab, click on + Add Account
In the add account Modal, add a name and the email address for the Zoom account. Then, select Zoom as the provider and then click on Connect Zoom Account
A new window with the Zoom oauth/consent screen will now be open.
Optionally, check the box that reads: Allow this app to use my shared access permissions
Click the Allow button.
The Zoom account will now be connected and the Zoom for Pyas app is added.
Usage
Here, we discuss how Pyas is used once a Zoom account has been connected.
Read/List Meetings.
To list meetings for a Zoom account from the the dashboard, follow these instructions here: Get Meetings.
To list meetings via the REST API, make a GET request to the following endpoint:
https://api.pyas.io/zoom/meetings. For more details on using the REST API, visit the documentation here: API Reference - Get All Meetings.
Create Meetings
To create meetings for a Zoom account from the dashboard, follow these instructions here: Create Meeting
To create meetings via the REST API, make a POST request to the following endpoint:
https://api.pyas.io/zoom/meetings. For more details on using the REST API, visit the documentation here: API Reference - Create a Meeting.
Update Meetings
To update a meeting for a Zoom account from the dashboard, follow these instructions: Update a Meeting.
To update meetings via the REST API, make a PATCH request to the following endpoint:
https://api.pyas.io/zoom/meetings. For more details on using the REST API, visit the documentation here: API Reference - Update a Meeting.
Delete Meetings
To delete a meeting for a Zoom account from the dashboard, follow these instructions: Delete a Meeting.
To delete meetings via the REST API, make a DELETE request to the following endpoint:
https://api.pyas.io/zoom/meetings. For more details on using the REST API, visit the documentation here: API Reference - Delete a Meeting.
Removing the App
Users reserve the right to remove the Zoom for Pyas app and revoke Pyas's access to their Zoom account at any time.
When you, the user, revoke access to your account, Pyas will no longer be able to access any of your meetings or personal information. The connected/integrated Zoom account will no longer work.
In order continue using Pyas after access has been revoked, the user/developer will need to reconnect the account following the steps from the Adding the App section above in this document.
To remove the Zoom for Pyas app, end-users can follow these simple steps:
Login to your Zoom Account and navigate to the Zoom App Marketplace.
Click Manage >> Added Apps or search for the "Zoom for Pyas" app.
Click the "Zoom for Pyas" app.
Click Remove.
Testing the Zoom Integration
Before you start testing the integration, make sure you have at least one valid/active API key created with Read and Write scopes. Read How to Create an API Key
From the Apps page, select the app that has the accounts you would like to test.
In the accounts list, click on the "expand" button on an account card to open an Account View modal.
An Account View modal will open, and you'll be able to start testing the account connection.
Under Test Account Connection, follow the straight forward options to Get Meetings, Create Meeting, Update a Meeting and Delete a Meeting
Get Meetings
To get/read a list of Zoom meetings, simply click the Send Request button and if any meetings exist, they will be displayed in the response section on the right.
Create Meeting
Fill in the required fields to create a new meeting and then click the Send Request button.
Update a Meeting
Copy a meeting ID from the Get Meetings tab
From the Update a Meeting tab, paste in the meeting ID you just copied into the Meeting ID field
Fill in the field(s) that you would like to update
Click Send Request
Delete a Meeting
Copy a meeting ID from the list of meetings returned on the Get Meetings tab
Paste the meeting ID into the Meeting ID field in the Delete Meeting tab
Click Send Request
Last updated
