Skip to main content

Authorization

Follow this guide to create a new Acuity Scheduling credential that will allow Nexla to authenticate to and exchange data with your Acuity Scheduling account.
acuity_scheduling_api_auth.png

Acuity Scheduling

Prerequisites

Acuity Scheduling supports two authentication methods for the REST API, and the credentials required depend on which method best fits the integration scenario. Review the prerequisites for the relevant method below before creating a credential in Nexla.

HTTP Basic Authentication

HTTP Basic Authentication uses your Acuity Scheduling User ID (numeric) and API Key. This method is best for single-account or internal integrations where the application owner is also the Acuity Scheduling account owner.

  1. Sign in to your Acuity Scheduling account at acuityscheduling.com.

  2. From the main menu, navigate to Integrations.

  3. Scroll to the API section near the bottom of the Integrations page. Acuity Scheduling displays both your numeric User ID and your API Key in this section.

  4. Copy the User ID and the API Key values, and store them securely. These credentials grant full access to your Acuity Scheduling account data, so they should be treated like a password.

    If your API Key has been exposed or you want to rotate it, click Reset API Key in the API section of the Integrations page. Resetting the key invalidates the previous value, so any existing integrations using the old key will need to be updated.

For complete information about Basic Authentication with the Acuity Scheduling API, see the Acuity Scheduling Quick Start guide.

OAuth 2.0

OAuth 2.0 is the recommended authentication method for multi-tenant integrations or any application that connects on behalf of other Acuity Scheduling users. Instead of sharing API keys, each Acuity Scheduling user authorizes your application through a standard OAuth 2.0 consent flow.

  1. Register an OAuth 2.0 client application with Acuity Scheduling at acuityscheduling.com/oauth2/register. Provide the requested application details, including the application name, description, and redirect URI.

    • Redirect URI: Set this to the Nexla OAuth callback URL provided in the Nexla credential overlay. The redirect URI registered with Acuity Scheduling must exactly match the one used during the authorization flow.
  2. After the application is approved, Acuity Scheduling provides a Client ID and Client Secret. Copy and store both values securely — the Client Secret is shown only once.

  3. Confirm that the api-v1 scope is enabled for your application. This is currently the only scope supported by Acuity Scheduling and grants full API access on behalf of the authorizing user.

For complete information about the OAuth 2.0 flow and registration process, see the Acuity Scheduling OAuth2 documentation.

Important

The Client Secret and API Key values grant access to Acuity Scheduling account data. Store them in a secure secret manager, never commit them to source control, and rotate them immediately if you suspect they have been exposed.

Create an Acuity Scheduling Credential

  • To create a new Acuity Scheduling credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Authentication Method

  1. Select the authentication method that matches your Acuity Scheduling setup, and complete the corresponding fields.

Acuity Scheduling Authentication Methods

Authenticate using your Acuity Scheduling User ID and API Key. Best suited for single-account or internal integrations where the integration owner is also the Acuity Scheduling account owner.

  1. Enter your numeric Acuity Scheduling **User ID** in the **User ID** field. This value is found in the **API** section under **Integrations** in Acuity Scheduling.
  2. Enter your Acuity Scheduling **API Key** in the **API Key** field. This value is also found in the **API** section under **Integrations** in Acuity Scheduling and is treated as a secret.

Save the Credential

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.