> For the complete documentation index, see [llms.txt](https://docs.planetcrust.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.planetcrust.com/human-connections/zoom/zoom.md). # Zoom

Try @HumanBuy @Human SubscriptionJoin @Human Community

Put Zoom to Work with @Human Automations and @Human Agents

The Zoom Connection documents all Triggers, Actions and Query Operations available for creating automations via the Zoom API.

{% embed url="" %} #### What can you do with the Asana Connection? * Connect to the Zoom API in a few clicks * Use the related Zoom Operations (see below) in @Human Automations or @Human Agents ### Related Operations #### Trigger Operations **User Created** Triggers on: users/created Triggered when a new user is created in the Zoom account. **User Updated** Triggers on: users/updated Triggered when a user's profile information is updated. **User Deleted** Triggers on: users/deleted Triggered when a user is deleted or disassociated from the account. **User Activated** Triggers on: users/activated Triggered when a user account is activated. **User Deactivated** Triggers on: users/deactivated Triggered when a user account is deactivated. **Meeting Created** Triggers on: meetings/created Triggered when a new meeting is scheduled or created. **Meeting Updated** Triggers on: meetings/updated Triggered when a scheduled meeting is updated. **Meeting Deleted** Triggers on: meetings/deleted Triggered when a scheduled meeting is deleted. **Meeting Started** Triggers on: meetings/started Triggered when a scheduled or instant meeting has started. **Meeting Ended** Triggers on: meetings/ended Triggered when a meeting has ended. **Meeting Registration Created** Triggers on: meetings/registration\_created Triggered when a new registrant registers for a meeting. **Meeting Participant Joined** Triggers on: meetings/participant\_joined Triggered when a participant joins a meeting. **Webinar Created** Triggers on: webinars/created Triggered when a new webinar is scheduled or created. **Webinar Updated** Triggers on: webinars/updated Triggered when a scheduled webinar is updated. **Webinar Deleted** Triggers on: webinars/deleted Triggered when a scheduled webinar is deleted. **Webinar Started** Triggers on: webinars/started Triggered when a scheduled webinar has started. **Webinar Ended** Triggers on: webinars/ended Triggered when a webinar has ended. **Webinar Registration Created** Triggers on: webinars/registration\_created Triggered when a new registrant registers for a webinar. **Webinar Participant Joined** Triggers on: webinars/participant\_joined Triggered when a participant joins a webinar. **Recording Completed** Triggers on: recordings/completed Triggered when a cloud recording has finished processing. **Recording Deleted** Triggers on: recordings/deleted Triggered when a cloud recording is deleted. **Recording Recovered** Triggers on: recordings/recovered Triggered when a deleted cloud recording is recovered from the trash. **Recording Transcript Completed** Triggers on: recordings/transcript\_completed Triggered when a cloud recording transcript has finished processing. **Contact Created** Triggers on: contacts/created Triggered when a new contact is created in the directory. **Contact Updated** Triggers on: contacts/updated Triggered when a contact's information is updated. **Contact Deleted** Triggers on: contacts/deleted Triggered when a contact is deleted from the directory. #### Action Operations [Action: Create a Meeting](/human-connections/zoom/zoom/action-create-a-meeting.md) [Action: Update a Meeting](/human-connections/zoom/zoom/action-update-a-meeting.md) [Action: Delete a Meeting](/human-connections/zoom/zoom/action-delete-a-meeting.md) #### Query Operations [Query: Find a Meeting](/human-connections/zoom/zoom/query-find-a-meeting.md) [Query: List Meeting](/human-connections/zoom/zoom/query-list-meeting.md) ### Related Automations Example link ### Obtaining Access Credentials To obtain a **System-to-System Personal Access Token (PAT)** for **Zoom**, follow these steps: #### **Prerequisites** * A **Zoom Pro/Business/Enterprise account** (free accounts cannot generate PATs). * **Admin or Owner** privileges to access the **Zoom Developer Console**. #### **Steps to Generate a Zoom PAT** 1. **Log in to the Zoom Developer Console** * Go to: * Sign in with your **Zoom admin credentials**. 2. **Create a New App (if needed)** * Navigate to **"Develop" → "Build App"**. * Select **"JWT"** (Legacy) or **"OAuth"** (if JWT is unavailable). * Fill in required details (App Name, Type, etc.). * Click **"Create"**. 3. **Generate the PAT** * In the app dashboard, go to **"App Credentials"**. * Under **"Personal Access Token"**, click **"Generate Token"**. * Copy the token (it will **not** be shown again). 4. **Set Token Expiry (Optional)** * By default, Zoom PATs **expire in 1 hour**. * If a longer duration is needed, use **OAuth** instead (not covered here). ### Configuring Webhooks 1. **Log in to the Zoom App Marketplace** * Go to and sign in. 2. **Create a Webhook-Capable App** * Select **Develop** > **Build App**. * Choose **Webhook Only** or **Server-to-Server OAuth** and click **Create**. * Enter the required app details and click **Create**. 3. **Enable Event Subscriptions** * Navigate to the **Feature** tab and toggle **Event Subscriptions** to **On**. * Click **Add Event Subscription** and provide a name. 4. **Set the Endpoint URL** * Enter your **Event Notification Endpoint URL** in the field provided. 5. **Select Event Types** * Click **Add Events** and select the specific events you want to subscribe to. * Click **Done** followed by **Save**. 6. **Obtain the Verification Secret** * Copy the **Secret Token** from the subscription details to use for event validation. ### Code (Apache v2.0): Service Connectivity and Metadata ``` { "handle": "zoom-api", "status": "active", "meta": { "short": "Zoom API", "description": "Connects to the Zoom API for managing meetings, webinars, and users.", "icon": "zoom", "tags": ["video", "conferencing", "meetings"] }, "service": { "baseURL": { "value": "https://api.zoom.us/v2" }, "protocol": "https", "contentType": "application/json", "auth": { "method": "system_to_system", "params": {} } } } ``` ### Code (Apache v2.0): List of External Resources and Internal Mapping ``` [ { "handle": "users", "meta": { "short": "Users", "description": "Zoom account users including hosts, administrators, and basic members." }, "endpoint": { "value": "/users", "placeholders": [] }, "fields": [ { "name": "id", "type": "String", "selector": [ "id" ], "meta": { "description": "Zoom user ID." } }, { "name": "first_name", "type": "String", "selector": [ "first_name" ], "meta": { "description": "First name of the user." } }, { "name": "last_name", "type": "String", "selector": [ "last_name" ], "meta": { "description": "Last name of the user." } }, { "name": "email", "type": "String", "selector": [ "email" ], "meta": { "description": "Email address of the user." } }, { "name": "type", "type": "Integer", "selector": [ "type" ], "meta": { "description": "User type: 1=Basic, 2=Licensed, 3=On-prem." } }, { "name": "role_name", "type": "String", "selector": [ "role_name" ], "meta": { "description": "Name of the role assigned to the user." } }, { "name": "status", "type": "String", "selector": [ "status" ], "meta": { "description": "Account status of the user (active, inactive, pending)." } } ], "operations": { "list": { "method": "GET", "path": { "value": "", "placeholders": [] }, "headers": {}, "queryParams": { "page_size": { "value": "30", "placeholders": [] }, "status": { "value": "{{status}}", "placeholders": [ { "name": "status", "type": "String", "description": "Filter users by status (active, inactive, pending).", "required": false, "default": "active", "options": [ "active", "inactive", "pending" ] } ] } }, "bodyTemplate": { "value": "", "placeholders": [] } }, "read": { "method": "GET", "path": { "value": "/{{userId}}", "placeholders": [ { "name": "userId", "type": "String", "description": "User ID or email address.", "required": true, "default": "", "options": [] } ] }, "headers": {}, "queryParams": {}, "bodyTemplate": { "value": "", "placeholders": [] } }, "create": { "method": "POST", "path": { "value": "", "placeholders": [] }, "headers": {}, "queryParams": {}, "bodyTemplate": { "value": "{\"action\":\"create\",\"user_info\":{\"email\":\"{{email}}\",\"type\":{{type}},\"first_name\":\"{{first_name}}\",\"last_name\":\"{{last_name}}\"}}", "placeholders": [ { "name": "email", "type": "String", "description": "User email address.", "required": true, "default": "", "options": [] }, { "name": "type", "type": "Integer", "description": "User type (1=Basic, 2=Licensed, 3=On-prem).", "required": true, "default": "1", "options": [] }, { "name": "first_name", "type": "String", "description": "User first name.", "required": false, "default": "", "options": [] }, { "name": "last_name", "type": "String", "description": "User last name.", "required": false, "default": "", "options": [] } ] } }, "update": { "method": "PATCH", "path": { "value": "/{{userId}}", "placeholders": [ { "name": "userId", "type": "String", "description": "User ID or email address.", "required": true, "default": "", "options": [] } ] }, "headers": {}, "queryParams": {}, "bodyTemplate": { "value": "{\"first_name\":\"{{first_name}}\",\"last_name\":\"{{last_name}}\",\"type\":{{type}}}", "placeholders": [ { "name": "first_name", "type": "String", "description": "User first name.", "required": false, "default": "", "options": [] }, { "name": "last_name", "type": "String", "description": "User last name.", "required": false, "default": "", "options": [] }, { "name": "type", "type": "Integer", "description": "User type (1=Basic, 2=Licensed, 3=On-prem).", "required": false, "default": "1", "options": [] } ] } }, "delete": { "method": "DELETE", "path": { "value": "/{{userId}}", "placeholders": [ { "name": "userId", "type": "String", "description": "User ID or email address.", "required": true, "default": "", "options": [] } ] }, "headers": {}, "queryParams": { "action": { "value": "{{action}}", "placeholders": [ { "name": "action", "type": "String", "description": "Disassociate or delete the user.", "required": false, "default": "disassociate", "options": [ "disassociate", "delete" ] } ] } }, "bodyTemplate": { "value": "", "placeholders": [] } } }, "webhooks": [ { "event": "created", "path": "/webhooks/users/created", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the user created." } }, { "name": "email", "type": "String", "selector": ["payload", "object", "email"], "meta": { "description": "Email address of the user." } }, { "name": "first_name", "type": "String", "selector": ["payload", "object", "first_name"], "meta": { "description": "First name of the user." } }, { "name": "last_name", "type": "String", "selector": ["payload", "object", "last_name"], "meta": { "description": "Last name of the user." } } ] }, { "event": "updated", "path": "/webhooks/users/updated", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the user updated." } }, { "name": "email", "type": "String", "selector": ["payload", "object", "email"], "meta": { "description": "Updated email address of the user." } } ] }, { "event": "deleted", "path": "/webhooks/users/deleted", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the user deleted." } }, { "name": "email", "type": "String", "selector": ["payload", "object", "email"], "meta": { "description": "Email address of the user deleted." } } ] }, { "event": "activated", "path": "/webhooks/users/activated", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the user activated." } }, { "name": "email", "type": "String", "selector": ["payload", "object", "email"], "meta": { "description": "Email address of the user activated." } } ] }, { "event": "deactivated", "path": "/webhooks/users/deactivated", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the user deactivated." } }, { "name": "email", "type": "String", "selector": ["payload", "object", "email"], "meta": { "description": "Email address of the user deactivated." } } ] } ] }, { "handle": "meetings", "meta": { "short": "Meetings", "description": "Zoom meetings including scheduled, live, and past meetings." }, "endpoint": { "value": "/users/{{userId}}/meetings", "placeholders": [ { "name": "userId", "type": "String", "description": "User ID or email or 'me'.", "required": true, "default": "me", "options": [] } ] }, "fields": [ { "name": "id", "type": "Integer", "selector": [ "id" ], "meta": {} }, { "name": "uuid", "type": "String", "selector": [ "uuid" ], "meta": {} }, { "name": "topic", "type": "String", "selector": [ "topic" ], "meta": {} }, { "name": "agenda", "type": "String", "selector": [ "agenda" ], "meta": {} }, { "name": "start_time", "type": "String", "selector": [ "start_time" ], "meta": {} }, { "name": "duration", "type": "Integer", "selector": [ "duration" ], "meta": {} }, { "name": "timezone", "type": "String", "selector": [ "timezone" ], "meta": {} }, { "name": "join_url", "type": "String", "selector": [ "join_url" ], "meta": {} }, { "name": "host_id", "type": "String", "selector": [ "host_id" ], "meta": {} }, { "name": "status", "type": "String", "selector": [ "status" ], "meta": {} } ], "operations": { "list": { "method": "GET", "path": { "value": "", "placeholders": [] }, "headers": {}, "queryParams": { "type": { "value": "{{type}}", "placeholders": [ { "name": "type", "type": "String", "description": "Meeting type (scheduled, live, upcoming, upcoming_meetings, previous_meetings).", "required": false, "default": "scheduled", "options": [ "scheduled", "live", "upcoming", "upcoming_meetings", "previous_meetings" ] } ] }, "page_size": { "value": "30", "placeholders": [] } }, "bodyTemplate": { "value": "", "placeholders": [] } }, "read": { "method": "GET", "path": { "value": "/{{meetingId}}", "placeholders": [ { "name": "meetingId", "type": "String", "description": "Meeting ID or UUID.", "required": true, "default": "", "options": [] } ] }, "headers": {}, "queryParams": {}, "bodyTemplate": { "value": "", "placeholders": [] } }, "create": { "method": "POST", "path": { "value": "", "placeholders": [] }, "headers": {}, "queryParams": {}, "bodyTemplate": { "value": "{\"topic\":\"{{topic}}\",\"type\":{{type}},\"start_time\":\"{{start_time}}\",\"duration\":{{duration}},\"timezone\":\"{{timezone}}\",\"agenda\":\"{{agenda}}\"}", "placeholders": [ { "name": "topic", "type": "String", "description": "Meeting topic.", "required": true, "default": "", "options": [] }, { "name": "type", "type": "Integer", "description": "Meeting type (1=Instant, 2=Scheduled, 3=Recurring no fixed time, 8=Recurring fixed time).", "required": true, "default": "2", "options": [] }, { "name": "start_time", "type": "String", "description": "Meeting start time in ISO 8601 format.", "required": false, "default": "", "options": [] }, { "name": "duration", "type": "Integer", "description": "Meeting duration in minutes.", "required": false, "default": "60", "options": [] }, { "name": "timezone", "type": "String", "description": "Meeting timezone.", "required": false, "default": "UTC", "options": [] }, { "name": "agenda", "type": "String", "description": "Meeting agenda.", "required": false, "default": "", "options": [] } ] } }, "update": { "method": "PATCH", "path": { "value": "/{{meetingId}}", "placeholders": [ { "name": "meetingId", "type": "String", "description": "Meeting ID or UUID.", "required": true, "default": "", "options": [] } ] }, "headers": {}, "queryParams": {}, "bodyTemplate": { "value": "{\"topic\":\"{{topic}}\",\"start_time\":\"{{start_time}}\",\"duration\":{{duration}},\"timezone\":\"{{timezone}}\",\"agenda\":\"{{agenda}}\"}", "placeholders": [ { "name": "topic", "type": "String", "description": "Meeting topic.", "required": false, "default": "", "options": [] }, { "name": "start_time", "type": "String", "description": "Meeting start time in ISO 8601 format.", "required": false, "default": "", "options": [] }, { "name": "duration", "type": "Integer", "description": "Meeting duration in minutes.", "required": false, "default": "60", "options": [] }, { "name": "timezone", "type": "String", "description": "Meeting timezone.", "required": false, "default": "UTC", "options": [] }, { "name": "agenda", "type": "String", "description": "Meeting agenda.", "required": false, "default": "", "options": [] } ] } }, "delete": { "method": "DELETE", "path": { "value": "/{{meetingId}}", "placeholders": [ { "name": "meetingId", "type": "String", "description": "Meeting ID or UUID.", "required": true, "default": "", "options": [] } ] }, "headers": {}, "queryParams": { "schedule_for_reminder": { "value": "{{schedule_for_reminder}}", "placeholders": [ { "name": "schedule_for_reminder", "type": "Boolean", "description": "Send cancellation email to alternative hosts.", "required": false, "default": "false", "options": [] } ] } }, "bodyTemplate": { "value": "", "placeholders": [] } } }, "webhooks": [ { "event": "created", "path": "/webhooks/meetings/created", "payload": [ { "name": "id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the meeting created." } }, { "name": "uuid", "type": "String", "selector": ["payload", "object", "uuid"], "meta": { "description": "UUID of the meeting created." } }, { "name": "topic", "type": "String", "selector": ["payload", "object", "topic"], "meta": { "description": "Meeting topic." } }, { "name": "start_time", "type": "String", "selector": ["payload", "object", "start_time"], "meta": { "description": "Scheduled start time for the meeting." } } ] }, { "event": "updated", "path": "/webhooks/meetings/updated", "payload": [ { "name": "id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the meeting updated." } }, { "name": "uuid", "type": "String", "selector": ["payload", "object", "uuid"], "meta": { "description": "UUID of the meeting updated." } } ] }, { "event": "deleted", "path": "/webhooks/meetings/deleted", "payload": [ { "name": "id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the meeting deleted." } }, { "name": "uuid", "type": "String", "selector": ["payload", "object", "uuid"], "meta": { "description": "UUID of the meeting deleted." } } ] }, { "event": "started", "path": "/webhooks/meetings/started", "payload": [ { "name": "id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the meeting that started." } }, { "name": "uuid", "type": "String", "selector": ["payload", "object", "uuid"], "meta": { "description": "UUID of the meeting that started." } }, { "name": "start_time", "type": "String", "selector": ["payload", "object", "start_time"], "meta": { "description": "Time when the meeting started." } } ] }, { "event": "ended", "path": "/webhooks/meetings/ended", "payload": [ { "name": "id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the meeting that ended." } }, { "name": "uuid", "type": "String", "selector": ["payload", "object", "uuid"], "meta": { "description": "UUID of the meeting that ended." } }, { "name": "end_time", "type": "String", "selector": ["payload", "object", "end_time"], "meta": { "description": "Time when the meeting ended." } } ] }, { "event": "registration_created", "path": "/webhooks/meetings/registration_created", "payload": [ { "name": "meeting_id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Meeting ID for which registration was created." } }, { "name": "registrant_id", "type": "String", "selector": ["payload", "object", "registrant", "id"], "meta": { "description": "Unique identifier of the registrant." } }, { "name": "email", "type": "String", "selector": ["payload", "object", "registrant", "email"], "meta": { "description": "Email address of the registrant." } } ] }, { "event": "participant_joined", "path": "/webhooks/meetings/participant_joined", "payload": [ { "name": "meeting_id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Meeting ID joined." } }, { "name": "participant_id", "type": "String", "selector": ["payload", "object", "participant", "id"], "meta": { "description": "Unique identifier of the participant." } }, { "name": "user_name", "type": "String", "selector": ["payload", "object", "participant", "user_name"], "meta": { "description": "Name of the participant." } } ] } ] }, { "handle": "webinars", "meta": { "short": "Webinars", "description": "Zoom webinars for large-scale events, including scheduling and management." }, "endpoint": { "value": "/users/{{userId}}/webinars", "placeholders": [ { "name": "userId", "type": "String", "description": "User ID or email or 'me'.", "required": true, "default": "me", "options": [] } ] }, "fields": [ { "name": "id", "type": "Integer", "selector": [ "id" ], "meta": {} }, { "name": "uuid", "type": "String", "selector": [ "uuid" ], "meta": {} }, { "name": "topic", "type": "String", "selector": [ "topic" ], "meta": {} }, { "name": "agenda", "type": "String", "selector": [ "agenda" ], "meta": {} }, { "name": "start_time", "type": "String", "selector": [ "start_time" ], "meta": {} }, { "name": "duration", "type": "Integer", "selector": [ "duration" ], "meta": {} }, { "name": "timezone", "type": "String", "selector": [ "timezone" ], "meta": {} }, { "name": "join_url", "type": "String", "selector": [ "join_url" ], "meta": {} }, { "name": "host_id", "type": "String", "selector": [ "host_id" ], "meta": {} }, { "name": "status", "type": "String", "selector": [ "status" ], "meta": {} } ], "operations": { "list": { "method": "GET", "path": { "value": "", "placeholders": [] }, "headers": {}, "queryParams": { "page_size": { "value": "30", "placeholders": [] } }, "bodyTemplate": { "value": "", "placeholders": [] } }, "read": { "method": "GET", "path": { "value": "/{{webinarId}}", "placeholders": [ { "name": "webinarId", "type": "String", "description": "Webinar ID or UUID.", "required": true, "default": "", "options": [] } ] }, "headers": {}, "queryParams": {}, "bodyTemplate": { "value": "", "placeholders": [] } }, "create": { "method": "POST", "path": { "value": "", "placeholders": [] }, "headers": {}, "queryParams": {}, "bodyTemplate": { "value": "{\"topic\":\"{{topic}}\",\"type\":{{type}},\"start_time\":\"{{start_time}}\",\"duration\":{{duration}},\"timezone\":\"{{timezone}}\",\"agenda\":\"{{agenda}}\"}", "placeholders": [ { "name": "topic", "type": "String", "description": "Webinar topic.", "required": true, "default": "", "options": [] }, { "name": "type", "type": "Integer", "description": "Webinar type (5=Webinar, 6=Recurring, 9=Recurring no fixed time).", "required": true, "default": "5", "options": [] }, { "name": "start_time", "type": "String", "description": "Webinar start time in ISO 8601 format.", "required": false, "default": "", "options": [] }, { "name": "duration", "type": "Integer", "description": "Webinar duration in minutes.", "required": false, "default": "60", "options": [] }, { "name": "timezone", "type": "String", "description": "Webinar timezone.", "required": false, "default": "UTC", "options": [] }, { "name": "agenda", "type": "String", "description": "Webinar agenda.", "required": false, "default": "", "options": [] } ] } }, "update": { "method": "PATCH", "path": { "value": "/{{webinarId}}", "placeholders": [ { "name": "webinarId", "type": "String", "description": "Webinar ID or UUID.", "required": true, "default": "", "options": [] } ] }, "headers": {}, "queryParams": {}, "bodyTemplate": { "value": "{\"topic\":\"{{topic}}\",\"start_time\":\"{{start_time}}\",\"duration\":{{duration}},\"timezone\":\"{{timezone}}\",\"agenda\":\"{{agenda}}\"}", "placeholders": [ { "name": "topic", "type": "String", "description": "Webinar topic.", "required": false, "default": "", "options": [] }, { "name": "start_time", "type": "String", "description": "Webinar start time in ISO 8601 format.", "required": false, "default": "", "options": [] }, { "name": "duration", "type": "Integer", "description": "Webinar duration in minutes.", "required": false, "default": "60", "options": [] }, { "name": "timezone", "type": "String", "description": "Webinar timezone.", "required": false, "default": "UTC", "options": [] }, { "name": "agenda", "type": "String", "description": "Webinar agenda.", "required": false, "default": "", "options": [] } ] } }, "delete": { "method": "DELETE", "path": { "value": "/{{webinarId}}", "placeholders": [ { "name": "webinarId", "type": "String", "description": "Webinar ID or UUID.", "required": true, "default": "", "options": [] } ] }, "headers": {}, "queryParams": {}, "bodyTemplate": { "value": "", "placeholders": [] } } }, "webhooks": [ { "event": "created", "path": "/webhooks/webinars/created", "payload": [ { "name": "id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the webinar created." } }, { "name": "uuid", "type": "String", "selector": ["payload", "object", "uuid"], "meta": { "description": "UUID of the webinar created." } }, { "name": "topic", "type": "String", "selector": ["payload", "object", "topic"], "meta": { "description": "Webinar topic." } }, { "name": "start_time", "type": "String", "selector": ["payload", "object", "start_time"], "meta": { "description": "Scheduled start time for the webinar." } } ] }, { "event": "updated", "path": "/webhooks/webinars/updated", "payload": [ { "name": "id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the webinar updated." } }, { "name": "uuid", "type": "String", "selector": ["payload", "object", "uuid"], "meta": { "description": "UUID of the webinar updated." } } ] }, { "event": "deleted", "path": "/webhooks/webinars/deleted", "payload": [ { "name": "id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the webinar deleted." } }, { "name": "uuid", "type": "String", "selector": ["payload", "object", "uuid"], "meta": { "description": "UUID of the webinar deleted." } } ] }, { "event": "started", "path": "/webhooks/webinars/started", "payload": [ { "name": "id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the webinar that started." } }, { "name": "uuid", "type": "String", "selector": ["payload", "object", "uuid"], "meta": { "description": "UUID of the webinar that started." } }, { "name": "start_time", "type": "String", "selector": ["payload", "object", "start_time"], "meta": { "description": "Time when the webinar started." } } ] }, { "event": "ended", "path": "/webhooks/webinars/ended", "payload": [ { "name": "id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the webinar that ended." } }, { "name": "uuid", "type": "String", "selector": ["payload", "object", "uuid"], "meta": { "description": "UUID of the webinar that ended." } }, { "name": "end_time", "type": "String", "selector": ["payload", "object", "end_time"], "meta": { "description": "Time when the webinar ended." } } ] }, { "event": "registration_created", "path": "/webhooks/webinars/registration_created", "payload": [ { "name": "webinar_id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Webinar ID for which registration was created." } }, { "name": "registrant_id", "type": "String", "selector": ["payload", "object", "registrant", "id"], "meta": { "description": "Unique identifier of the registrant." } }, { "name": "email", "type": "String", "selector": ["payload", "object", "registrant", "email"], "meta": { "description": "Email address of the registrant." } } ] }, { "event": "participant_joined", "path": "/webhooks/webinars/participant_joined", "payload": [ { "name": "webinar_id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Webinar ID joined." } }, { "name": "participant_id", "type": "String", "selector": ["payload", "object", "participant", "id"], "meta": { "description": "Unique identifier of the participant." } }, { "name": "user_name", "type": "String", "selector": ["payload", "object", "participant", "user_name"], "meta": { "description": "Name of the participant." } } ] } ] }, { "handle": "recordings", "meta": { "short": "Cloud Recordings", "description": "Cloud recordings for meetings and webinars including metadata and file URLs." }, "endpoint": { "value": "/users/{{userId}}/recordings", "placeholders": [ { "name": "userId", "type": "String", "description": "User ID or email or 'me'.", "required": true, "default": "me", "options": [] } ] }, "fields": [ { "name": "uuid", "type": "String", "selector": [ "uuid" ], "meta": {} }, { "name": "id", "type": "Integer", "selector": [ "id" ], "meta": {} }, { "name": "topic", "type": "String", "selector": [ "topic" ], "meta": {} }, { "name": "start_time", "type": "String", "selector": [ "start_time" ], "meta": {} }, { "name": "duration", "type": "Integer", "selector": [ "duration" ], "meta": {} }, { "name": "total_size", "type": "Integer", "selector": [ "total_size" ], "meta": {} }, { "name": "recording_files_0_id", "type": "String", "selector": [ "recording_files", 0, "id" ], "meta": { "description": "Unique identifier of the first recording file." }, "multivalue": true }, { "name": "recording_files_0_file_type", "type": "String", "selector": [ "recording_files", 0, "file_type" ], "meta": { "description": "File type of the first recording (e.g., MP4, M4A, CHAT)." }, "multivalue": true }, { "name": "recording_files_0_download_url", "type": "String", "selector": [ "recording_files", 0, "download_url" ], "meta": { "description": "Download URL of the first recording file." }, "multivalue": true }, { "name": "recording_files_0_play_url", "type": "String", "selector": [ "recording_files", 0, "play_url" ], "meta": { "description": "Play URL of the first recording file." }, "multivalue": true }, { "name": "recording_files_0_status", "type": "String", "selector": [ "recording_files", 0, "status" ], "meta": { "description": "Processing status of the first recording file (e.g., completed)." }, "multivalue": true }, { "name": "recording_files_0_recording_type", "type": "String", "selector": [ "recording_files", 0, "recording_type" ], "meta": { "description": "Recording type of the first file (e.g., shared_screen_with_speaker_view)." }, "multivalue": true } ], "operations": { "list": { "method": "GET", "path": { "value": "", "placeholders": [] }, "headers": {}, "queryParams": { "from": { "value": "{{from}}", "placeholders": [ { "name": "from", "type": "String", "description": "Start date in YYYY-MM-DD.", "required": false, "default": "", "options": [] } ] }, "to": { "value": "{{to}}", "placeholders": [ { "name": "to", "type": "String", "description": "End date in YYYY-MM-DD.", "required": false, "default": "", "options": [] } ] }, "page_size": { "value": "30", "placeholders": [] } }, "bodyTemplate": { "value": "", "placeholders": [] } }, "read": { "method": "GET", "path": { "value": "/meetings/{{meetingId}}/recordings", "placeholders": [ { "name": "meetingId", "type": "String", "description": "Meeting ID or UUID.", "required": true, "default": "", "options": [] } ] }, "headers": {}, "queryParams": {}, "bodyTemplate": { "value": "", "placeholders": [] } } }, "webhooks": [ { "event": "completed", "path": "/webhooks/recordings/completed", "payload": [ { "name": "uuid", "type": "String", "selector": ["payload", "object", "uuid"], "meta": { "description": "UUID of the recording completed." } }, { "name": "id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the recording." } }, { "name": "topic", "type": "String", "selector": ["payload", "object", "topic"], "meta": { "description": "Topic of the meeting or webinar recorded." } }, { "name": "start_time", "type": "String", "selector": ["payload", "object", "start_time"], "meta": { "description": "Start time of the recording." } } ] }, { "event": "deleted", "path": "/webhooks/recordings/deleted", "payload": [ { "name": "uuid", "type": "String", "selector": ["payload", "object", "uuid"], "meta": { "description": "UUID of the recording deleted." } }, { "name": "id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the recording deleted." } } ] }, { "event": "recovered", "path": "/webhooks/recordings/recovered", "payload": [ { "name": "uuid", "type": "String", "selector": ["payload", "object", "uuid"], "meta": { "description": "UUID of the recording recovered." } }, { "name": "id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the recording recovered." } } ] }, { "event": "transcript_completed", "path": "/webhooks/recordings/transcript_completed", "payload": [ { "name": "uuid", "type": "String", "selector": ["payload", "object", "uuid"], "meta": { "description": "UUID of the recording for which transcript was completed." } }, { "name": "id", "type": "Integer", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the recording." } } ] } ] }, { "handle": "contacts", "meta": { "short": "Contacts", "description": "Zoom contacts, including external and internal directory entries used as leads or attendees." }, "endpoint": { "value": "/contacts", "placeholders": [] }, "fields": [ { "name": "id", "type": "String", "selector": [ "id" ], "meta": {} }, { "name": "email", "type": "String", "selector": [ "email" ], "meta": {} }, { "name": "first_name", "type": "String", "selector": [ "first_name" ], "meta": {} }, { "name": "last_name", "type": "String", "selector": [ "last_name" ], "meta": {} }, { "name": "phone_number", "type": "String", "selector": [ "phone_number" ], "meta": {} }, { "name": "presence_status", "type": "String", "selector": [ "presence_status" ], "meta": {} } ], "operations": { "list": { "method": "GET", "path": { "value": "", "placeholders": [] }, "headers": {}, "queryParams": { "search_key": { "value": "{{search_key}}", "placeholders": [ { "name": "search_key", "type": "String", "description": "Search by name or email.", "required": false, "default": "", "options": [] } ] }, "page_size": { "value": "30", "placeholders": [] } }, "bodyTemplate": { "value": "", "placeholders": [] } } }, "webhooks": [ { "event": "created", "path": "/webhooks/contacts/created", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the contact created." } }, { "name": "email", "type": "String", "selector": ["payload", "object", "email"], "meta": { "description": "Email address of the contact." } }, { "name": "first_name", "type": "String", "selector": ["payload", "object", "first_name"], "meta": { "description": "First name of the contact." } }, { "name": "last_name", "type": "String", "selector": ["payload", "object", "last_name"], "meta": { "description": "Last name of the contact." } } ] }, { "event": "updated", "path": "/webhooks/contacts/updated", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the contact updated." } }, { "name": "email", "type": "String", "selector": ["payload", "object", "email"], "meta": { "description": "Updated email address of the contact." } } ] }, { "event": "deleted", "path": "/webhooks/contacts/deleted", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the contact deleted." } } ] } ] }, { "handle": "events", "meta": { "short": "Zoom Events", "description": "Zoom Webinars Plus & Events entities, including multi-session events, registrations, and attendance." }, "endpoint": { "value": "/events", "placeholders": [] }, "fields": [ { "name": "id", "type": "String", "selector": [ "id" ], "meta": {} }, { "name": "name", "type": "String", "selector": [ "name" ], "meta": {} }, { "name": "start_time", "type": "String", "selector": [ "start_time" ], "meta": {} }, { "name": "end_time", "type": "String", "selector": [ "end_time" ], "meta": {} }, { "name": "timezone", "type": "String", "selector": [ "timezone" ], "meta": {} }, { "name": "status", "type": "String", "selector": [ "status" ], "meta": {} } ], "operations": { "list": { "method": "GET", "path": { "value": "", "placeholders": [] }, "headers": {}, "queryParams": { "page_size": { "value": "30", "placeholders": [] } }, "bodyTemplate": { "value": "", "placeholders": [] } }, "read": { "method": "GET", "path": { "value": "/{{eventId}}", "placeholders": [ { "name": "eventId", "type": "String", "description": "Zoom Event ID.", "required": true, "default": "", "options": [] } ] }, "headers": {}, "queryParams": {}, "bodyTemplate": { "value": "", "placeholders": [] } } }, "webhooks": [ { "event": "created", "path": "/webhooks/events/created", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the Zoom Event created." } }, { "name": "name", "type": "String", "selector": ["payload", "object", "name"], "meta": { "description": "Name of the event." } }, { "name": "start_time", "type": "String", "selector": ["payload", "object", "start_time"], "meta": { "description": "Start time of the event." } } ] }, { "event": "updated", "path": "/webhooks/events/updated", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the Zoom Event updated." } }, { "name": "name", "type": "String", "selector": ["payload", "object", "name"], "meta": { "description": "Updated name of the event." } } ] }, { "event": "deleted", "path": "/webhooks/events/deleted", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the Zoom Event deleted." } } ] } ] }, { "handle": "calendars", "meta": { "short": "Calendars", "description": "Zoom calendaring integration surfaces, exposing calendar events and availability synced from external providers." }, "endpoint": { "value": "/calendars", "placeholders": [] }, "fields": [ { "name": "id", "type": "String", "selector": [ "id" ], "meta": {} }, { "name": "summary", "type": "String", "selector": [ "summary" ], "meta": {} }, { "name": "time_zone", "type": "String", "selector": [ "time_zone" ], "meta": {} }, { "name": "primary", "type": "Boolean", "selector": [ "primary" ], "meta": {} } ], "operations": { "list": { "method": "GET", "path": { "value": "", "placeholders": [] }, "headers": {}, "queryParams": {}, "bodyTemplate": { "value": "", "placeholders": [] } } }, "webhooks": [ { "event": "sync_started", "path": "/webhooks/calendars/sync_started", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the calendar." } }, { "name": "summary", "type": "String", "selector": ["payload", "object", "summary"], "meta": { "description": "Summary of the calendar." } } ] }, { "event": "sync_completed", "path": "/webhooks/calendars/sync_completed", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the calendar." } }, { "name": "summary", "type": "String", "selector": ["payload", "object", "summary"], "meta": { "description": "Summary of the calendar." } } ] } ] }, { "handle": "calendar_events", "meta": { "short": "Calendar Events", "description": "Individual calendar events from connected calendaring systems accessible via Zoom calendaring endpoints." }, "endpoint": { "value": "/calendars/{{calendarId}}/events", "placeholders": [ { "name": "calendarId", "type": "String", "description": "Identifier for the calendar.", "required": true, "default": "", "options": [] } ] }, "fields": [ { "name": "id", "type": "String", "selector": [ "id" ], "meta": {} }, { "name": "summary", "type": "String", "selector": [ "summary" ], "meta": {} }, { "name": "description", "type": "String", "selector": [ "description" ], "meta": {} }, { "name": "start_time", "type": "String", "selector": [ "start", "dateTime" ], "meta": {} }, { "name": "end_time", "type": "String", "selector": [ "end", "dateTime" ], "meta": {} }, { "name": "location", "type": "String", "selector": [ "location" ], "meta": {} }, { "name": "organizer", "type": "String", "selector": [ "organizer", "displayName" ], "meta": {} }, { "name": "attendees_omitted", "type": "Boolean", "selector": [ "attendeesOmitted" ], "meta": {} } ], "operations": { "list": { "method": "GET", "path": { "value": "", "placeholders": [] }, "headers": {}, "queryParams": { "time_min": { "value": "{{time_min}}", "placeholders": [ { "name": "time_min", "type": "String", "description": "Lower bound (inclusive) for event start time (ISO 8601).", "required": false, "default": "", "options": [] } ] }, "time_max": { "value": "{{time_max}}", "placeholders": [ { "name": "time_max", "type": "String", "description": "Upper bound (exclusive) for event start time (ISO 8601).", "required": false, "default": "", "options": [] } ] }, "page_size": { "value": "50", "placeholders": [] } }, "bodyTemplate": { "value": "", "placeholders": [] } }, "read": { "method": "GET", "path": { "value": "/{{eventId}}", "placeholders": [ { "name": "eventId", "type": "String", "description": "Calendar event ID.", "required": true, "default": "", "options": [] } ] }, "headers": {}, "queryParams": {}, "bodyTemplate": { "value": "", "placeholders": [] } } }, "webhooks": [ { "event": "created", "path": "/webhooks/calendar_events/created", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the calendar event created." } }, { "name": "summary", "type": "String", "selector": ["payload", "object", "summary"], "meta": { "description": "Summary of the calendar event." } }, { "name": "start_time", "type": "String", "selector": ["payload", "object", "start", "dateTime"], "meta": { "description": "Start time of the calendar event." } } ] }, { "event": "updated", "path": "/webhooks/calendar_events/updated", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the calendar event updated." } }, { "name": "summary", "type": "String", "selector": ["payload", "object", "summary"], "meta": { "description": "Updated summary of the calendar event." } } ] }, { "event": "deleted", "path": "/webhooks/calendar_events/deleted", "payload": [ { "name": "id", "type": "String", "selector": ["payload", "object", "id"], "meta": { "description": "Unique identifier of the calendar event deleted." } } ] } ] } ] ```

Try @HumanBuy @Human SubscriptionJoin @Human Community

--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.planetcrust.com/human-connections/zoom/zoom.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.