Zoom

The Zoom auth provider enables tools and agents to call the Zoom API on behalf of a user.

What’s documented here

This page describes how to use and configure Zoom auth with Arcade.

This auth provider is used by:

• Your app code that needs to call Zoom APIs
• Or, your custom tools that need to call Zoom APIs

Configuring Zoom auth

In a production environment, you will most likely want to use your own Zoom app credentials. This way, your users will see your application’s name requesting permission.

Before showing how to configure your Zoom app credentials, let’s go through the steps to create a Zoom app.

Create a Zoom app

• Follow Zoom’s guide to registering an app  on the Zoom marketplace
• Set the redirect URL to the redirect URL generated by Arcade (see below) and enable Strict Mode
• Enable the Zoom features and permissions (scopes) that your app needs
• Copy the client ID and client secret to use below

Next, add the Zoom app to Arcade.

Configuring your own Zoom Auth Provider in Arcade

Using Zoom auth in app code

Use the Zoom auth provider in your own agents and AI apps to get a user token for the Zoom API. See authorizing agents with Arcade to understand how this works.

Use client.auth.start() to get a user token for the Zoom API:

from arcadepy import Arcade
 
client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
 
user_id = "{arcade_user_id}"
 
# Start the authorization process
auth_response = client.auth.start(
    user_id=user_id,
    provider="zoom",
    scopes=["meeting:read:list_upcoming_meetings"],
)
 
if auth_response.status != "completed":
    print("Please complete the authorization challenge in your browser:")
    print(auth_response.url)
 
# Wait for the authorization to complete
auth_response = client.auth.wait_for_completion(auth_response)
 
token = auth_response.context.token
# Do something interesting with the token...

import { Arcade } from "@arcadeai/arcadejs";
 
const client = new Arcade(); // Automatically finds the `ARCADE_API_KEY` env variable
 
const userId = "{arcade_user_id}";
 
// Start the authorization process
let authResponse = await client.auth.start(userId, "zoom", [
  "meeting:read:list_upcoming_meetings",
]);
 
if (authResponse.status !== "completed") {
  console.log("Please complete the authorization challenge in your browser:");
  console.log(authResponse.url);
}
 
// Wait for the authorization to complete
authResponse = await client.auth.waitForCompletion(authResponse);
 
const token = authResponse.context.token;
// Do something interesting with the token...

Using Zoom auth in custom tools

You can author your own custom tools that interact with the Zoom API.

Use the Zoom() auth class to specify that a tool requires authorization with Zoom. The context.authorization.token field will be automatically populated with the user’s Zoom token:

from typing import Annotated, Optional
 
import httpx
 
from arcade_tdk import ToolContext, tool
from arcade_tdk.auth import Zoom
 
 
@tool(
    requires_auth=Zoom(
        scopes=["meeting:read:list_upcoming_meetings"],
    )
)
async def list_upcoming_meetings(
    context: ToolContext,
    user_id: Annotated[
        Optional[str],
        "The user's user ID or email address. Defaults to 'me' for the current user.",
    ] = "me",
) -> Annotated[dict, "List of upcoming meetings within the next 24 hours"]:
    """List a Zoom user's upcoming meetings within the next 24 hours."""
    url = f"https://api.zoom.us/v2/users/{user_id}/upcoming_meetings"
    headers = {"Authorization": f"Bearer {context.authorization.token}"}
 
    async with httpx.AsyncClient() as client:
        response = await client.get(url, headers=headers)
        response.raise_for_status()
        return response.json()