Zoom Guide - Pinkfish - AI Agents & Workflows for Getting Work Done

What can you do with it?

The Zoom API allows you to manage video conferencing through programmatic access. You can create and manage meetings, schedule webinars, retrieve user information, update meeting settings, and track participant data for comprehensive video conferencing management. Key capabilities include:

Create, update, and delete meetings and webinars
Manage meeting participants and registrants
Access recording data and transcripts
Real-time webhook notifications for meeting events
User management and account information retrieval

Prerequisites

Before using the Zoom integration, you’ll need:

Active Zoom Account - Sign up at zoom.us if you don’t have one
Zoom Developer Account - Create one at Zoom Marketplace (for advanced integrations)
Zoom OAuth Application - Set up an OAuth app in your Zoom developer dashboard (for custom implementations)
Required Credentials (for custom integrations):
- Client ID
- Client Secret
- Scopes/Permissions

Required Scopes

For the Pinkfish app integration, the following permissions are automatically configured:

meeting:read:list_meetings - View user’s meetings
meeting:write:meeting - Create and manage meetings
meeting:read:meeting - Read meeting information
webinar:write:webinar - Create and manage webinars
webinar:read:webinar - Read webinar information
user:read:user - Read user information (required)

Adding the Pinkfish App

Follow these step-by-step instructions to add the Pinkfish app to your Zoom account:

Step 1: Access the Zoom App Marketplace

Log in to your Zoom account at zoom.us
Navigate to the Zoom App Marketplace
Search for “Pinkfish” in the search bar

Step 2: Install the Pinkfish App

Click on the Pinkfish app from the search results
Review the app permissions and features
Click “Add” or “Install” to add the app to your account
You may be prompted to authorize the app - click “Authorize” or “Allow”

Step 3: Complete the Setup

After authorization, you’ll be redirected to complete the setup
Follow any additional configuration steps as prompted
The Pinkfish app is now connected to your Zoom account

Troubleshooting Installation

If you encounter issues during installation, see our Troubleshooting section below.

Setup and Configuration

Verifying Your Connection

To verify that the Pinkfish app is properly connected:

Go to your Zoom account settings
Navigate to Apps > Added Apps
Look for “Pinkfish” in your list of installed apps
The status should show as “Connected” or “Active”

Usage

The Pinkfish Zoom integration allows you to automate and manage your video conferencing workflows. Here are the main use cases and how to implement them:

Common Use Cases

Meeting Management:

Automatically create meetings based on calendar events
Update meeting details when plans change
Send meeting invitations and reminders
Track meeting attendance and participation

Webinar Automation:

Schedule and manage large-scale webinars
Automate registrant management
Generate post-webinar reports and analytics

Recording Management:

Automatically process and store meeting recordings
Generate transcripts and summaries
Distribute recordings to relevant stakeholders

User Management:

Sync user data between systems
Manage user permissions and access levels
Track user activity and engagement

How to use it?

Basic Command Structure

/your-zoom-connection [action] [required-parameters] [optional-parameters]

Parameters

Required:

action - The action to perform (create, get, update, delete, list)
userId - User ID (often “me” for current user)
meetingId or webinarId - Meeting or webinar ID for specific operations

Optional:

topic - Meeting or webinar topic
start_time - Scheduled start time
duration - Meeting duration in minutes
timezone - Meeting timezone
settings - Meeting configuration settings

Tools

List User Meetings

Retrieve a list of meetings for the current user. Parameters:

userId (required) - User ID (use “me” for current user)
type (optional) - Meeting type filter
page_size (optional) - Number of results per page

Example:

/your-zoom-connection
action: list_meetings
userId: me
page_size: 30

Response:

{
  "meetings": [
    {
      "agenda": "My Meeting",
      "created_at": "2022-03-23T05:31:16Z",
      "duration": 60,
      "host_id": "30R7kT7bTIKSNUFEuH_Qlg",
      "id": 97763643886,
      "join_url": "https://example.com/j/11111",
      "start_time": "2022-03-23T06:00:00Z",
      "timezone": "America/Los_Angeles",
      "topic": "My Meeting",
      "type": 2,
      "uuid": "aDYlohsHRtCd4ii1uC2+hA=="
    }
  ],
  "page_count": 1,
  "total_records": 1
}

Get User Details

Retrieve details about a specific user. Parameters:

userId (required) - User ID (use “me” for current user)

Example:

/your-zoom-connection
action: get_user
userId: me

Response:

{
  "id": "FoGxYEx_abcdefg",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "type": 2,
  "status": "active",
  "pmi": 1234567890,
  "timezone": "America/Los_Angeles",
  "created_at": "2023-01-01T12:00:00Z",
  "language": "en-US",
  "phone_number": "+15551234567",
  "role_name": "Owner"
}

Create Meeting

Create a new scheduled meeting. Parameters:

userId (required) - User ID (use “me” for current user)
topic (required) - Meeting topic
type (required) - Meeting type (1=instant, 2=scheduled, 3=recurring)
start_time (required) - Meeting start time
duration (required) - Meeting duration in minutes
timezone (optional) - Meeting timezone
agenda (optional) - Meeting agenda
settings (optional) - Meeting settings object

Example:

/your-zoom-connection
action: create_meeting
userId: me
topic: Project Kickoff Meeting
type: 2
start_time: 2023-05-15T10:00:00Z
duration: 60
timezone: America/Los_Angeles
agenda: Discuss project goals and timeline
settings: {"host_video": true, "participant_video": true, "waiting_room": true}

Response:

{
  "id": 12345678901,
  "host_id": "FoGxYEx_abcdefg",
  "topic": "Project Kickoff Meeting",
  "type": 2,
  "status": "waiting",
  "start_time": "2023-05-15T10:00:00Z",
  "duration": 60,
  "timezone": "America/Los_Angeles",
  "agenda": "Discuss project goals and timeline",
  "created_at": "2023-05-01T09:30:00Z",
  "start_url": "https://zoom.us/s/12345678901?zak=xxxx",
  "join_url": "https://zoom.us/j/12345678901",
  "password": "123456",
  "settings": {
    "host_video": true,
    "participant_video": true,
    "waiting_room": true
  }
}

Get Meeting Details

Retrieve details about a specific meeting. Parameters:

meetingId (required) - Meeting ID

Example:

/your-zoom-connection
action: get_meeting
meetingId: 12345678901

Response:

{
  "id": 12345678901,
  "host_id": "FoGxYEx_abcdefg",
  "topic": "Project Kickoff Meeting",
  "type": 2,
  "status": "waiting",
  "start_time": "2023-05-15T10:00:00Z",
  "duration": 60,
  "timezone": "America/Los_Angeles",
  "agenda": "Discuss project goals and timeline",
  "created_at": "2023-05-01T09:30:00Z",
  "start_url": "https://zoom.us/s/12345678901?zak=xxxx",
  "join_url": "https://zoom.us/j/12345678901",
  "password": "123456",
  "settings": {
    "host_video": true,
    "participant_video": true,
    "waiting_room": true
  }
}

Update Meeting

Update an existing meeting’s details. Parameters:

meetingId (required) - Meeting ID
topic (optional) - Updated meeting topic
duration (optional) - Updated duration
agenda (optional) - Updated agenda
settings (optional) - Updated meeting settings

Example:

/your-zoom-connection
action: update_meeting
meetingId: 12345678901
topic: Updated Project Kickoff Meeting
duration: 90
agenda: Updated: Discuss project goals, timeline, and resource allocation
settings: {"join_before_host": true, "waiting_room": false}

Response:

{
  "status": "success"
}

Delete Meeting

Delete a scheduled meeting. Parameters:

meetingId (required) - Meeting ID

Example:

/your-zoom-connection
action: delete_meeting
meetingId: 12345678901

Response:

{
  "status": "success"
}

List Webinars

List all webinars for a specific user. Parameters:

userId (required) - User ID (use “me” for current user)
page_size (optional) - Number of results per page

Example:

/your-zoom-connection
action: list_webinars
userId: me
page_size: 30

Response:

{
  "webinars": [
    {
      "uuid": "abcdefghijklmnop",
      "id": 98765432101,
      "host_id": "FoGxYEx_abcdefg",
      "topic": "Quarterly Product Update",
      "type": 5,
      "start_time": "2023-06-15T14:00:00Z",
      "duration": 60,
      "timezone": "America/Los_Angeles",
      "agenda": "New product features and roadmap",
      "created_at": "2023-05-20T10:00:00Z",
      "join_url": "https://zoom.us/j/98765432101"
    }
  ],
  "page_count": 1,
  "total_records": 1
}

Create Webinar

Create a new webinar. Parameters:

userId (required) - User ID (use “me” for current user)
topic (required) - Webinar topic
type (required) - Webinar type (5=webinar, 6=recurring webinar)
start_time (required) - Webinar start time
duration (required) - Webinar duration in minutes
timezone (optional) - Webinar timezone
agenda (optional) - Webinar agenda
settings (optional) - Webinar settings object

Example:

/your-zoom-connection
action: create_webinar
userId: me
topic: New Feature Launch Webinar
type: 5
start_time: 2023-07-15T15:00:00Z
duration: 60
timezone: America/Los_Angeles
agenda: Introducing our latest product features
settings: {"host_video": true, "practice_session": true, "auto_recording": "cloud"}

Response:

{
  "id": 98765432102,
  "host_id": "FoGxYEx_abcdefg",
  "topic": "New Feature Launch Webinar",
  "type": 5,
  "start_time": "2023-07-15T15:00:00Z",
  "duration": 60,
  "timezone": "America/Los_Angeles",
  "agenda": "Introducing our latest product features",
  "created_at": "2023-06-01T11:30:00Z",
  "join_url": "https://zoom.us/j/98765432102",
  "registration_url": "https://zoom.us/webinar/register/WN_abcdefghijklmno",
  "settings": {
    "host_video": true,
    "practice_session": true,
    "auto_recording": "cloud"
  }
}

Get Webinar Participants

Retrieve a list of participants for a specific webinar. Parameters:

webinarId (required) - Webinar ID
page_size (optional) - Number of results per page

Example:

/your-zoom-connection
action: get_webinar_participants
webinarId: 98765432101
page_size: 30

Response:

{
  "participants": [
    {
      "id": "user123",
      "name": "Alice Smith",
      "user_email": "alice@example.com",
      "join_time": "2023-06-15T14:05:00Z",
      "leave_time": "2023-06-15T15:00:00Z",
      "duration": 55,
      "attentiveness_score": "Good"
    },
    {
      "id": "user456",
      "name": "Bob Johnson",
      "user_email": "bob@example.com",
      "join_time": "2023-06-15T14:00:00Z",
      "leave_time": "2023-06-15T15:00:00Z",
      "duration": 60,
      "attentiveness_score": "Good"
    }
  ],
  "page_count": 1,
  "total_records": 3
}

Removing the Pinkfish App

If you need to remove the Pinkfish app from your Zoom account, follow these steps:

Step-by-Step Removal Process

Log in to your Zoom account at zoom.us
Navigate to Account Management > Apps
Click on Manage > Added Apps
Search for “Pinkfish” or locate it in your list of installed apps
Click on the Pinkfish app
Click “Remove” or “Uninstall”
Confirm the removal when prompted

What Happens When You Remove the App

Immediate Effects:

All active automations using Zoom will stop working
The app will no longer have access to your Zoom account
No new meetings, webinars, or recordings can be created through Pinkfish

Data Handling:

Your Zoom Data: Remains in your Zoom account unchanged
Pinkfish Data: Historical data and logs are retained for 30 days for troubleshooting purposes, then permanently deleted
Active Workflows: Any running workflows involving Zoom will be paused and require reconfiguration

Before Removing:

Export any important data or reports you need
Update any automated workflows that depend on Zoom integration
Inform team members who may be affected by the removal

Troubleshooting

Common Issues and Solutions

Problem: Can’t find Pinkfish in the Zoom App Marketplace

Solution: Ensure you’re logged into your Zoom account and try searching for “Pinkfish” exactly as spelled
Alternative: Contact our support team for a direct installation link

Problem: Authorization fails during installation

Solution:
1. Clear your browser cache and cookies
2. Try using an incognito/private browsing window
3. Ensure pop-ups are enabled for zoom.us
4. Check that you have admin permissions for your Zoom account

Problem: Meetings aren’t being created automatically

Solution:
1. Verify the Pinkfish app is still connected in your Zoom settings
2. Check that your automation workflows are active
3. Ensure the meeting parameters meet Zoom’s requirements
4. Verify your account has sufficient meeting licenses

Problem: Can’t access meeting recordings

Solution:
1. Confirm recording permissions are enabled in your Zoom account
2. Check that recordings are stored in the expected location (local vs. cloud)
3. Verify the recording has finished processing
4. Ensure your Zoom plan includes cloud recording (if applicable)

Contact Support

Pinkfish AI is committed to ensuring a seamless experience with our workflow platform. If you have any questions, encounter issues, or require assistance with your Zoom integration, our Support Team is available to help.

How to Get Support

For All Plans:

Documentation: First, consult our comprehensive Documentation for common troubleshooting steps and guidance
Discord: Join our Discord community for peer support and general questions
Email Support: Send detailed questions to support@pinkfish.ai

For Enterprise Customers:

Slack Channel: Available for select enterprise customers for general communications
Account Manager: Contact your dedicated Pinkfish AI Account Manager for strategic support

When to Submit a Support Ticket

Submit support tickets for the following types of issues: Technical & Product Support:

Reporting a potential bug or defect with Zoom integration
Troubleshooting issues not covered in documentation
Questions regarding Pinkfish AI features or Zoom configurations
Requests for feature enablement

Billing Support:

Questions related to purchases, invoices, or payments

Workflow & Integration Support:

Issues with Zoom workflow execution or performance
Problems with meeting creation or management through Pinkfish

Required Information for Support Tickets

To facilitate timely resolution, please include:

Steps Taken: List troubleshooting steps already attempted (e.g., restarting browser, clearing cache)
Issue Details: Include workflow IDs, Zoom meeting IDs, API call logs, or related identifiers
Error Messages: Attach screenshots or logs showing any error messages
Frequency & Impact: Indicate if the issue is new or recurring, and whether it affects single or multiple users
Your Zoom account email
Your Pinkfish account ID

How to Submit a Support Ticket

Support requests can be submitted through the following channels:

Email: support@pinkfish.ai

Slack Communication

While Pinkfish AI maintains a Slack channel for select enterprise customers for general communications, all official support tickets must be tracked through support@pinkfish.ai.

Critical Issues

For critical incidents that impact production workflows, please mark your ticket as Urgent priority when submitting to support@pinkfish.ai to ensure immediate attention.

Important Notes

All official support tickets must be tracked through support@pinkfish.ai
Before reaching out, users are encouraged to consult the Documentation for common solutions
Enterprise customers should designate authorized contacts for support ticket submission

Notes

Meeting Types:

1 = Instant meeting
2 = Scheduled meeting
3 = Recurring meeting with no fixed time
8 = Recurring meeting with fixed time

Webinar Types:

5 = Webinar
6 = Recurring webinar
9 = Recurring webinar with fixed time

Important Notes:

All times should be in ISO 8601 format
Use “me” as userId for operations on the current user’s account
Ensure the Pinkfish app has the necessary permissions configured
The users:read scope is required for all operations

Get Started

Organization

Agents

Workflows

Resources

Integrations

Orchestration

Credits & Pricing

Skills

How To Guides

Release Notes

Support

​What can you do with it?

​Prerequisites

​Required Scopes

​Adding the Pinkfish App

​Step 1: Access the Zoom App Marketplace

​Step 2: Install the Pinkfish App

​Step 3: Complete the Setup

​Troubleshooting Installation

​Setup and Configuration

​Verifying Your Connection

​Usage

​Common Use Cases

​How to use it?

​Basic Command Structure

​Parameters

​Tools

​List User Meetings

​Get User Details

​Create Meeting

​Get Meeting Details

​Update Meeting

​Delete Meeting

​List Webinars

​Create Webinar

​Get Webinar Participants

​Removing the Pinkfish App

​Step-by-Step Removal Process

​What Happens When You Remove the App

​Troubleshooting

​Common Issues and Solutions

​Contact Support

​How to Get Support

​When to Submit a Support Ticket

​Required Information for Support Tickets

​How to Submit a Support Ticket

​Slack Communication

​Critical Issues

​Important Notes

​Notes

What can you do with it?

Prerequisites

Required Scopes

Adding the Pinkfish App

Step 1: Access the Zoom App Marketplace

Step 2: Install the Pinkfish App

Step 3: Complete the Setup

Troubleshooting Installation

Setup and Configuration

Verifying Your Connection

Usage

Common Use Cases

How to use it?

Basic Command Structure

Parameters

Tools

List User Meetings

Get User Details

Create Meeting

Get Meeting Details

Update Meeting

Delete Meeting

List Webinars

Create Webinar

Get Webinar Participants

Removing the Pinkfish App

Step-by-Step Removal Process

What Happens When You Remove the App

Troubleshooting

Common Issues and Solutions

Contact Support

How to Get Support

When to Submit a Support Ticket

Required Information for Support Tickets

How to Submit a Support Ticket

Slack Communication

Critical Issues

Important Notes

Notes