Zoom auth provider

The Zoom auth provider enables tools and agents to call the Zoom API on behalf of a user. Behind the scenes, the Arcade Engine and the Zoom auth provider seamlessly manage Zoom OAuth 2.0 authorization for your users.

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.

You can use your own Zoom credentials in both the Arcade Cloud and in a self-hosted Arcade Engine instance.

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: https://cloud.arcade.dev/api/v1/oauth/callback 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 your Arcade Engine configuration. You can do this in the Arcade Dashboard, or by editing the engine.yaml file directly (for a self-hosted instance).

Configuring your own Zoom Auth Provider in Arcade

There are two ways to configure your Zoom app credentials in Arcade:

1. From the Arcade Dashboard GUI
2. By editing the engine.yaml file directly (for a self-hosted Arcade Engine)

We show both options step-by-step below.

export ZOOM_CLIENT_ID="<your client ID>"
export ZOOM_CLIENT_SECRET="<your client secret>"

ZOOM_CLIENT_ID="<your client ID>"
ZOOM_CLIENT_SECRET="<your client secret>"

auth:
  providers:
    - id: default-zoom
      description: "The default Zoom provider"
      enabled: true
      type: oauth2
      provider_id: zoom
      client_id: ${env:ZOOM_CLIENT_ID}
      client_secret: ${env:ZOOM_CLIENT_SECRET}

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 = "user@example.com"
 
# 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 = "user@example.com";
 
// 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.sdk import ToolContext, tool
from arcade.sdk.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()