Skip to main content

​
What’s supported

​
Supported actions

This connector supports:
  • Read Actions, including full historic backfill. Please note that incremental reading is only supported for appointments, availability/classes, blocks. For all other objects, a full read of the Acuity Scheduling instance will be done per scheduled read.
  • Write Actions.
  • Proxy Actions, using the base URL https://acuityscheduling.com.

​
Supported objects

The Acuity Scheduling connector supports reading from the following objects: The Acuity Scheduling connector supports writing to the following objects:

​
Example integration

For an example manifest file of an Acuity Scheduling integration, visit our samples repo on Github.

​
Before You Get Started

To integrate Acuity Scheduling with Ampersand, you will need an Acuity Scheduling Account. Once your account is created, you’ll need to register an Oauth app and obtain the following credentials from your app:
  • Client ID
  • Client Secret
  • Scopes
You will then use these credentials and scopes to connect your application to Ampersand.

​
Create an Acuity Scheduling Account

Here’s how you can sign up for an Acuity Scheduling account:

​
Creating an Acuity Scheduling App

Follow the steps below to create an Acuity Scheduling app:
  1. Go to Acuity Scheduling OAuth2 Account Registration.
  2. Enter the following details:
    1. **Account Name: **The name of your Acuity Scheduling account or organization.
    2. **Email Address: **The email address associated with your Acuity Scheduling account. This will be used for communication regarding your app.
    3. **Website: **The URL of your application’s website. This helps users understand what your application does.
    4. Application Description: A brief description of your application and its purpose.
    5. Callback URIs: Enter the Redirect URI as https://api.withampersand.com/callbacks/v1/oauth. This URI is where users will be redirected after authorizing your app.
  3. Click Save.
Acuity Scheduling App Creation You will see the Client ID and Client Secret in the app details. Note these credentials, as you will need them to connect your app to Ampersand. Acuity Scheduling App Creation

​
Add Your Acuity Scheduling App Info to Ampersand

  1. Log in to your Ampersand Dashboard.
  2. Select the project where you want to create an Acuity Scheduling integration. Ampersand Project Selection
  3. Select Provider Apps.
  4. Select Acuity Scheduling from the Provider list.
  5. Enter the previously obtained Client ID in the Client ID field and the Client Secret in the Client Secret field.
  6. Enter the scopes set for your application in Acuity Scheduling. Ampersand Integration
  7. Click Save Changes.

​
Using the connector

To start integrating with Acuity Scheduling:
  • Create a manifest file like the example above.
  • Deploy it using the amp CLI.
  • If you are using Read Actions, create a destination.
  • Embed the InstallIntegration UI component. The UI component will prompt the customer for OAuth authorization.
  • Start using the connector!
    • If your integration has Read Actions, you’ll start getting webhook messages.
    • If your integration has Write Actions, you can start making API calls to our Write API.
    • If your integration has Proxy Actions, you can start making Proxy API calls.