Generating a Workable API Key

How to create a new API key with the relevant permissions in Workable for use with Hatch's ATS integration.

H
Written by Hatch Engineering Team
Updated over a week ago

When you open your Greenhouse instance and generate a Harvest API Key for Hatch you will need to following the following steps and provide the following permissions.

Step 1: Log in to Workable and click Settings from the avatar dropdown in the top right hand corner of any page.

Step 2: Click on the Apps link under Integrations in the left column

Step 3: Scroll down to the API Access Tokens section and click Generate API Token.

Step 4: Enter Hatch as the Name and set Expires In to 2 years. You'll also want to ensure that this token has permissions to the following scopes:

  • r_candidates

  • r_jobs

  • r_requisitions

  • w_candidates

  • w_comments

Step 4: Once you have a token, copy the token.

Step 5: Enter your Workable subdomain. You can find this by looking at the URL bar when signed in to your Workable instance.

Step 6: Enter the API key that you copied in Step 4 and click Submit.

Did this answer your question?