Skip to content

This guide helps you configure an integration for Ashby ATS.

Before you begin, ensure that you have:

  • Access to an Ashby account with Organization Admin permissions.
  • Permission to create and manage API keys in Ashby.
  • A secure place to store the generated API key. Ashby shows the key only once when it is created.

Required API Scopes

ModuleScopePurpose
OrganizationReadRetrieve and read data about the organization's users

Generate an API Key

  1. Log in to Ashby as an Organization Admin.
  2. Navigate to Admin > Integrations > API Keys.
  3. Click + New to open the API key setup wizard.
  4. Enter a name for the key and select an integration partner if your Ashby setup requires one.
  5. In the API Scopes step, select the modules and scopes listed in Required API Scopes.
  6. Click Save and Continue.
  7. Copy the API key from the final step and store it securely.

For more information on generating Ashby API keys, see How do I generate an API key?.

Configure the Integration

Create your integration by supplying the following configuration values.

Integration ParameterDescription
SecretThis is the API key value generated from executing the steps above.