Zoom Integration Information

Spark Clinic x Zoom

Spark Clinic aims to ensure that you can easily use your Zoom account to conduct your clinic reducing the need for multiple subscriptions. You will find information below to support you and ensure that this integration works to your high expectations.

  1. Support Information

    Our support team is based in the UK and will endeavour to resolve your enquiries promptly.

    Support Team Hours of Operation 9am to 5pm UK time;
    First Response SLA Your query will be acknowledged within 1 business day of it being raised. ;
    Email or Raise a Ticket To email or create a ticket please click here
  2. Your Guide to Linking Your Zoom Account

    1. Login to your Spark Clinic Account and go to the Scheduling section where you can add a new 'Room' if you do not have one already configured.

    2. Select a room which you wish to sync your calendar to then scroll to the bottom and click the 'Sign In With Zoom' button. You will be redirected to the zoom page where you can login to your zoom account and authorise Spark Clinic to sync with your zoom account and create Zoom meetings.

    3. Now, when you create a video appointment for this room, a Zoom meeting will automatically be created for that appointment. You can access the zoom meeting directly from the Spark Clinic calendar or from your Zoom account.

    4. To remove the Spark Clinic application zoom synchronisation simply go back to the room configuration page by following steps 1 and 2. Then click the 'Sign Out From Zoom' button. This will remove the Zoom synchronisation from the room.

Zoom API Scopes

Meeting Scopes

meeting:read:meeting

Purpose: View details of meetings for users (including past and upcoming meetings).

Use Case: Retrieving meeting information, such as meeting IDs, topics, times, and participant details.

meeting:write:meeting

Purpose: Create and manage your meetings.

Use Case: Scheduling new meetings, modifying meeting settings, or adding alternative hosts.

meeting:update:meeting

Purpose: Update existing meetings for a user.

Use Case: Changing the meeting topic, time, or enabling/disabling features like waiting rooms or passwords.

meeting:delete:meeting

Purpose: Delete a user's meeting.

Use Case: Canceling scheduled meetings programmatically.

meeting:write:invite_links

Purpose: Create invite links for meetings.

Use Case: Generating and sharing meeting invitation links with attendees.

meeting:write:registrant

Purpose: Add registrants to a meeting.

Use Case: Adding participants to meetings that require prior registration.

User Scopes

user:read:token

Purpose: View a user's access token.

Use Case: Checking token validity or user authentication for session-based features.

user:delete:token

Purpose: Remove or revoke a user's token.

Use Case: Logging out users or revoking access to the application for security purposes.