{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":21685,"path":"integrate-applications/integration-hub/zoom-spoke.md","title":"Zoom Spoke","bundle":null,"doc_type":null,"release":"australia","body":"\n# Zoom Spoke\n\nCreate and manage Zoom meetings with the Zoom spoke from your ServiceNow instance. With this spoke, you can add participants, retrieve details, end or delete a meeting, or fetch the participant details of a conference.\n\n## Request apps on the Store\n\nVisit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the [ServiceNow Store version history release notes](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).\n\n## Integration Hub subscription\n\nThis spoke requires an Integration Hub subscription. For more information, see [Legal schedules - IntegrationHub overview](https://www.servicenow.com/content/dam/servicenow-assets/public/en-us/doc-type/legal/snc-addendum-integrationhub.pdf).\n\n## Spoke version\n\nZoom spoke v5.0.0 is the latest version. For version history of the spoke, see [Zoom spoke release notes](https://www.servicenow.com/docs/r/store-release-notes/store-integrationhub-rn-zoom.html).\n\n## Supported versions\n\nZoom API version v2.0.\n\n## Spoke dependencies\n\nIf you’re having trouble installing the app, make sure that these dependent plugins are installed:\n\n-   ServiceNow IntegrationHub Action Step - REST \\(com.glide.hub.action\\_step.rest\\)\n-   ServiceNow Flow Designer - Dynamic Inputs \\(com.glide.hub.dynamic\\_inputs\\)\n-   Key Management Framework \\(com.glide.kmf.global\\)\n-   NOW Platform Encryption \\(com.glide.now.platform.encryption\\)\n-   ServiceNow IntegrationHub Runtime \\(com.glide.hub.integration.runtime\\)\n-   Complex Object \\(com.glide.cobject\\)\n\n## Spoke flows\n\nThis spoke has no sample flows.\n\n## Spoke subflows\n\nThe Zoom spoke provides sample subflows for processing inbound events that are related to meetings, recordings, webinars, and users. Available sample subflows are described in the following table.\n\n<table id=\"table_hrg_1hg_h4b\"><thead><tr><th>\n\nSubflow\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nZoom Process Meeting Events\n\n</td><td>\n\nHandles Zoom meeting webhook events.\n\n</td></tr><tr><td>\n\nZoom Process Recording Events\n\n</td><td>\n\nHandles Zoom recording webhook events.\n\n</td></tr><tr><td>\n\nZoom Process User Events\n\n</td><td>\n\nHandles Zoom user webhook events.\n\n</td></tr><tr><td>\n\nZoom Process Webinar Event\n\n</td><td>\n\nHandles Zoom webinar webhook events.\n\n</td></tr><tr><td>\n\nCreate Zoom Meeting\n\n</td><td>\n\nCreates a Zoom meeting and provides the Zoom meeting URL.This subflow is used by the Meeting scheduler AI agent in the [ServiceNow Otto for Integration Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/now-assist-spokes.md) application.\n\n</td></tr></tbody>\n</table>## Spoke modules\n\nThe Zoom spoke adds the Zoom application to your instance and includes the modules in the following table.\n\n|Module|Description|\n|------|-----------|\n|Phone Numbers|Displays a list of Zoom Phone numbers.|\n|Zoom Webhook Registries|Displays a list of webhook registries that are associated to Zoom.|\n\n## Spoke actions\n\nThe Zoom spoke provides you with actions so that you can automate Zoom tasks when events occur in the ServiceNow AI Platform. Th available actions are described in the following table.\n\n<table id=\"table_u1p_kh2_hfb\"><thead><tr><th>\n\nCategory\n\n</th><th>\n\nAction\n\n</th><th>\n\nDescription\n\n</th><th>\n\nGranular scope needed\n\n</th></tr></thead><tbody><tr><td rowspan=\"3\">\n\nCloud Recording Management\n\n</td><td>\n\nLook up meeting recording settings\n\n</td><td>\n\nRetrieves the settings of the meeting’s cloud recordings.**Note:** The meeting password is retrieved and displayed as plain text.\n\n</td><td>\n\ncloud\\_recording:read:recording\\_settings:admin\n\n</td></tr><tr><td>\n\nLook up meeting recordings\n\n</td><td>\n\nRetrieves all the recorded meetings for the specified meeting ID.\n\n</td><td>\n\ncloud\\_recording:read:list\\_recording\\_files:admin\n\n</td></tr><tr><td>\n\nLook up recordings stream\n\n</td><td>\n\nLists all the recorded meetings of the specified user.\n\n</td><td>\n\ncloud\\_recording:read:list\\_user\\_recordings:admin\n\n</td></tr><tr><td rowspan=\"18\">\n\nPhone Management\n\n</td><td>\n\nAssign calling plan To User\n\n</td><td>\n\nAssigns a calling plan to a user.\n\n</td><td>\n\nphone:write:calling\\_plan:admin\n\n</td></tr><tr><td>\n\nAssign phone number to user\n\n</td><td>\n\nAssigns a phone number to a user who has already enabled Zoom Phone.\n\n</td><td>\n\nphone:write:user\\_number:admin\n\n</td></tr><tr><td>\n\nGet country codes \\(metadata\\)\n\n</td><td>\n\nRetrieves the metadata of countries and their ISO codes.\n\n</td><td>\n\n \n\n</td></tr><tr><td>\n\nLook up Account Call History Stream\n\n</td><td>\n\nRetrieves the call logs for an account.\n\n</td><td>\n\nphone:read:list\\_call\\_logs:admin\n\n</td></tr><tr><td>\n\nLook up calling plans\n\n</td><td>\n\nRetrieves a list of calling plans.\n\n</td><td>\n\nphone:read:list\\_calling\\_plans:admin\n\n</td></tr><tr><td>\n\nLook up phone number details\n\n</td><td>\n\nRetrieves the details of a specified phone number in a Zoom account.\n\n</td><td>\n\nphone:read:numbers:admin\n\n</td></tr><tr><td>\n\nLook up phone numbers stream\n\n</td><td>\n\nRetrieves the list of phone numbers.\n\n</td><td>\n\nphone:read:list\\_numbers:admin\n\n</td></tr><tr><td>\n\nLook up phone users stream\n\n</td><td>\n\nRetrieves all the users that are associated to an account with assigned Zoom Phone licenses.\n\n</td><td>\n\nphone:read:list\\_users:admin\n\n</td></tr><tr><td>\n\nLook up User Call History Stream\n\n</td><td>\n\nRetrieves the call logs of a user’s Zoom Phone.\n\n</td><td>\n\nphone:read:list\\_call\\_logs:admin\n\n</td></tr><tr><td>\n\nLook up user phone profile\n\n</td><td>\n\nRetrieves a Zoom Phone user’s profile.\n\n</td><td>\n\nphone:read:user:admin\n\n</td></tr><tr><td>\n\nLook up user recordings stream\n\n</td><td>\n\nRetrieves a Zoom Phone user’s recordings.\n\n</td><td>\n\nphone:read:list\\_recordings:admin\n\n</td></tr><tr><td>\n\nLook up user phone settings\n\n</td><td>\n\nRetrieve a user's Zoom Phone profile.\n\n</td><td>\n\nphone:read:user\\_setting:admin\n\n</td></tr><tr><td>\n\nLook up user voicemails Stream\n\n</td><td>\n\nRetrieves a Zoom Phone user’s voicemails.\n\n</td><td>\n\nphone:read:list\\_voicemails:admin\n\n</td></tr><tr><td>\n\nUnassign user calling plan\n\n</td><td>\n\nUnassigns a calling plan to a user who has enabled Zoom Phone.\n\n</td><td>\n\nphone:delete:users\\_calling\\_plan:admin\n\n</td></tr><tr><td>\n\nUnassign user phone number\n\n</td><td>\n\nUnassigns a phone number to a user who has enabled Zoom Phone.\n\n</td><td>\n\nphone:delete:user\\_number:admin\n\n</td></tr><tr><td>\n\nUpdate main company number\n\n</td><td>\n\nUpdates the main company number of an account.\n\n</td><td>\n\n \n\n</td></tr><tr><td>\n\nUpdate user phone profile\n\n</td><td>\n\nUpdates a user’s Zoom Phone profile.\n\n</td><td>\n\nphone:update:user:admin\n\n</td></tr><tr><td>\n\nUpdate user phone settings\n\n</td><td>\n\nUpdates the settings of a specific Zoom Phone user.\n\n</td><td>\n\nphone:update:user\\_setting:admin\n\n</td></tr><tr><td rowspan=\"11\">\n\nMeeting Management\n\n</td><td>\n\nAdd meeting registrant\n\n</td><td>\n\nRegisters a participant for a specific meeting.\n\n</td><td>\n\nmeeting:write:meeting:admin\n\n</td></tr><tr><td>\n\nCreate meeting\n\n</td><td>\n\nCreates a meeting for a user using their Zoom user ID or the email address and other details such as start time, type of meeting, and agenda. The action can also include in the meeting details one or more alternative hosts' email ID.\n\n</td><td>\n\nmeeting:write:meeting:admin\n\n</td></tr><tr><td>\n\nDownload Meeting Transcript\n\n</td><td>\n\nDownloads the meeting transcript for the specified transcript ID.\n\n</td><td>\n\ncloud\\_recording:read:recording:admin\n\n</td></tr><tr><td>\n\nDelete meeting\n\n</td><td>\n\nDeletes a specific meeting by using its meeting ID.\n\n</td><td>\n\nmeeting:delete:meeting:admin\n\n</td></tr><tr><td>\n\nEnd meeting\n\n</td><td>\n\nEnds an ongoing meeting.\n\n</td><td>\n\nmeeting:delete:meeting:admin\n\n</td></tr><tr><td>\n\nLook up meeting Details\n\n</td><td>\n\nGets details of a specific meeting by its meeting ID.\n\n</td><td>\n\nmeeting:read:meeting:admin\n\n</td></tr><tr><td>\n\nUpdate Meeting\n\n</td><td>\n\nIdentifies a meeting by its ID and then updates its details such as start time, duration, and topic.\n\n</td><td>\n\nmeeting:update:meeting:admin\n\n</td></tr><tr><td>\n\nLook up ended meeting instances\n\n</td><td>\n\nLists all the meeting instances that were ended.\n\n</td><td>\n\nmeeting:read:list\\_meetings:admin\n\n</td></tr><tr><td>\n\nLook up live meetings by user stream\n\n</td><td>\n\nLists all the live or ongoing meetings for a specific user.\n\n</td><td>\n\nmeeting:read:list\\_meetings:admin\n\n</td></tr><tr><td>\n\nLook up Meetings Stream\n\n</td><td>\n\nLists the given user's meetings.\n\n</td><td>\n\nmeeting:read:list\\_meetings:admin\n\n</td></tr><tr><td>\n\nLook up Past Meeting Participants Stream\n\n</td><td>\n\nLists information on participants from a past meeting.\n\n</td><td>\n\nmeeting:read:list\\_past\\_participants:admin\n\n</td></tr><tr><td rowspan=\"8\">\n\nUser Management\n\n</td><td>\n\nCreate user\n\n</td><td>\n\nCreates a user in your account. **Note:** A Zoom [pro plan](https://zoom.us/pricing) or later is required for this action. You must enable pre-provisioning for SSO users in your Zoom account.\n\n</td><td>\n\nuser:write:user:admin\n\n</td></tr><tr><td>\n\nDelete user\n\n</td><td>\n\nDeletes a specific user from your account.\n\n</td><td>\n\nuser:delete:user:admin\n\n</td></tr><tr><td>\n\nDisassociate user\n\n</td><td>\n\nUnlinks a specific user from your account.\n\n</td><td>\n\nuser:delete:user:admin\n\n</td></tr><tr><td>\n\nLook up user details\n\n</td><td>\n\nGets the details of a specific user on your account by using their user ID.\n\n</td><td>\n\nuser:read:user:admin\n\n</td></tr><tr><td>\n\nLook up users stream\n\n</td><td>\n\nRetrieves all the users that are associated to your account.\n\n</td><td>\n\nuser:read:list\\_users:admin\n\n</td></tr><tr><td>\n\nLook up User Settings\n\n</td><td>\n\nRetrieves the settings details for a users profile.\n\n</td><td>\n\nuser:read:settings:admin\n\n</td></tr><tr><td>\n\nUpdate User\n\n</td><td>\n\nUpdates the Zoom profile information of the required user.\n\n</td><td>\n\nuser:update:user:admin\n\n</td></tr><tr><td>\n\nUpdate user settings\n\n</td><td>\n\nUpdates the settings of a specific user.\n\n</td><td>\n\nuser:update:user:admin\n\n</td></tr><tr><td rowspan=\"9\">\n\nChat Management\n\n</td><td>\n\nAdd members to channel\n\n</td><td>\n\nAdds members to a Zoom channel.\n\n</td><td>\n\nteam\\_chat:write:members:admin\n\n</td></tr><tr><td>\n\nCreate channel\n\n</td><td>\n\nCreates a Zoom channel.\n\n</td><td>\n\nteam\\_chat:write:user\\_channel:admin\n\n</td></tr><tr><td>\n\nLook up channel\n\n</td><td>\n\nRetrieves the details of a Zoom channel.\n\n</td><td>\n\nteam\\_chat:read:user\\_channel:admin\n\n</td></tr><tr><td>\n\nLook up channel members stream\n\n</td><td>\n\nRetrieves the details of the members in a Zoom channel.\n\n</td><td>\n\nteam\\_chat:read:list\\_members:admin\n\n</td></tr><tr><td>\n\nLook up user chat message stream\n\n</td><td>\n\nRetrieves the details of a member's chats in a Zoom channel.\n\n</td><td>\n\nteam\\_chat:read:list\\_user\\_messages:admin\n\n</td></tr><tr><td>\n\nLook up user channels stream\n\n</td><td>\n\nRetrieves the names of theZoom channels.\n\n</td><td>\n\nteam\\_chat:read:list\\_user\\_channels:admin\n\n</td></tr><tr><td>\n\nRemove member from channel\n\n</td><td>\n\nRemoves a member from a Zoom channel.\n\n</td><td>\n\nteam\\_chat:delete:member:admin\n\n</td></tr><tr><td>\n\nSend chat message\n\n</td><td>\n\nSends a chat message to a Zoom channel.\n\n</td><td>\n\nteam\\_chat:write:user\\_message:admin\n\n</td></tr><tr><td>\n\nUpdate channel\n\n</td><td>\n\nUpdates a Zoom channel's details.\n\n</td><td>\n\nteam\\_chat:update:user\\_channel:admin\n\n</td></tr><tr><td>\n\nUtility Actions\n\n</td><td>\n\nCopy chat message attachment to record\n\n</td><td>\n\nCopies the attachment that contains the chat message to the incident record.\n\n</td><td>\n\nteam\\_chat:read:user\\_message:admin\n\n</td></tr><tr><td>\n\nWebinar Management\n\n</td><td>\n\nLook up Webinars Stream\n\n</td><td>\n\nRetrieves a list of upcoming or scheduled webinars for the required user.\n\n</td><td>\n\nwebinar:read:list\\_webinars:admin\n\n</td></tr></tbody>\n</table>## Available AI agents\n\nInstall Now Assist for Integration Hub and start using the available AI agents. For more information, see [ServiceNow Otto for Integration Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/now-assist-spokes.md).\n\nThis spoke provides standalone AI agents that mimic human-like intelligence to perform tasks in your ServiceNow instance.\n\n-   In the ServiceNow agentic system, you can create an agentic workflow that comprises of a set of large language model \\(LLM\\) instructions along with one or more standalone AI agents to execute an objective. See [Create an agentic workflow](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/configure-use-case-ai-agents.md) for information about adding AI agents to create agentic workflows as per your requirement and provide the required trigger.\n\n    You can also search for other available AI agents and add them to your agentic workflow. See [Find AI agents](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/find-ai-agents.md) for more information.\n\n-   You can create a clone of the required spoke AI agent and customize it as per your requirement. See [Duplicate an AI agent](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/clone-ai-agent.md) for more information about creating a clone.\n-   See [AI Agent Studio \\(legacy\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/na-ai-agents.md) for information about AI agents.\n\nAvailable AI agents include:\n\n|AI Agent|Description|\n|--------|-----------|\n|Zoom user management AI agent|Looks up the details of a user, and creates, deletes, and disassociates a user.|\n|Zoom meeting management AI agent|Creates, ends, and deletes meetings, looks up meeting details, and adds a meeting registrant.|\n|Zoom cloud recording management AI agent|Looks up meeting recordings and meeting recording settings.|\n|Zoom chat management AI agent|Enables users to create and manage chat channels, send and update messages, and handle member-related operations.|\n\nThere might be AI agents installed on your instance that are not used in agentic workflows. To learn how to see all agents that are available to you, see [Find AI agents](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/find-ai-agents.md).\n\n**Note:** Ensure that the user running an AI agent has the required roles and permissions to access data or perform operations on data in the table that is associated with the AI agent.\n\n## Zoom spoke requirements\n\nThese actions use REST calls, which can run on an instance or Zoom spoke See [Building flows](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/build-workflows/flows.md) for more information. Use the connection record that is associated with the Zoom alias to configure where actions run and set Zoom spoke selection attributes. For more information about the alias, see [Connection and credential alias](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/zoom-spoke.md).\n\n## Connection and credential alias requirements\n\nIntegration Hub uses aliases to manage connection and credential information. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection. For more information, see [Connections and Credentials](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/r-credentials.md).\n\nThis spoke uses the Zoom Connection &amp; Credential Alias record to authorize actions. For information about setting up the spoke, see [Set up the Zoom spoke](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/setup-zoom.md).\n\n"}}