Skip to main content
Generating an API access token requires Super Admin privileges in Workable.

​
Generating a Workable API token

StackOne authenticates with a Workable API access token. Workable calls this credential an API token; it is the same value as the API key used by this connection, and you paste it into the API Token field in StackOne Hub.

1

Sign in to Workable

Sign in to your Workable account.

  • Click your profile picture in the top right corner of the navigation bar to open the account menu.
  • Click Settings.
The Workable account menu opened from the top right profile picture, with Settings highlighted
2

Open the Apps page

The settings sidebar is on the left of the page. Scroll down the sidebar to the INTEGRATIONS section and click Apps.

The Workable settings sidebar scrolled to the INTEGRATIONS section, with Apps highlighted
3

Start generating a token

Scroll down to the API ACCESS TOKENS section and click Generate API token.

The API ACCESS TOKENS section with the Generate API token button highlighted
4

Name the token and set its expiry

In the Generate API token window, fill in the token details.

  • Name: StackOne Integration
  • Select a duration in Expires in (for example, 1 year). The connection stops working when the token expires, so note the date for renewal.
The Generate API token window with the Name, Expires in and API scopes fields highlighted
5

Select the API scopes

Enables actions: Approve Requisition, Comment On Candidate, Copy Candidate, Create Department, Create Employee, Create Employee Document, Create Job Candidate, Create Requisition, Create Talent Pool Candidate, Create Time Off Request, Create Webhook Subscription, Delete Department, Delete Member, Delete Webhook Subscription, Disqualify Candidate, Enable Member, Get Account Details, Get Candidate, Get Candidate Activities, Get Candidate Offer, Get Employee, Get Employee Documents, Get Event, Get Job, Get Job Activities, Get Job Application Form, Get Job Custom Attributes, Get Job Members, Get Job Questions, Get Job Recruiters, Get Job Stages, Get Requisition, Invite Member, List Accounts, List Candidates, List Custom Attributes, List Departments, List Disqualification Reasons, List Employee Fields, List Employees, List Events, List Jobs, List Legal Entities, List Members, List Permission Sets, List Recruiters, List Requisitions, List Stages, List Time Off Balances, List Time Off Categories, List Time Off Requests, List Webhook Subscriptions, List Work Schedules, Merge Departments, Move Candidate To Stage, Rate Candidate, Reject Requisition, Relocate Candidate, Revert Candidate Disqualification, Tag Candidate, Update Candidate, Update Candidate Custom Attribute, Update Department, Update Employee, Update Member, Update Requisition

Under API scopes, tick the checkbox next to each scope listed below. The list scrolls inside the window, so scroll within it to reach every scope; the scopes are listed alphabetically, with read (r_) scopes first and write (w_) scopes after them. Leave the other scopes (such as r_reviews, r_surveys and r_time_tracking) unticked unless you need them for other tools.

The API scopes list scrolled part-way down, with the selected scopes highlighted
6

Generate and copy the token

Scroll to the bottom of the API scopes list, confirm the remaining scopes are ticked, and click Generate token.

  • In the New API access token generated window, click the copy icon next to the token.
  • The token is only displayed once and cannot be viewed again after you close the window. Store it securely for use later.
  • Paste it into the API Token field in StackOne Hub.
The New API access token generated window with the token value hidden and the copy icon highlighted

​
Find your company subdomain

Your company subdomain identifies your Workable account and is the first part of your Workable address.

1

Open the company profile

In the settings sidebar (profile picture in the top right corner > Settings), scroll to the COMPANY section and click Company profile.

The Workable settings sidebar showing the COMPANY section, with Company profile highlighted
2

Copy the subdomain

Under COMPANY PROFILE, copy the value in the Subdomain field, without the .workable.com suffix, and paste it into the Company Subdomain field in StackOne Hub.

  • Format: {subdomain} from https://{subdomain}.workable.com
  • Example: if your Workable address is https://acme-inc.workable.com, enter acme-inc
The Company profile page with the Subdomain field and its .workable.com suffix highlighted
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Next Steps

Webhooks setup

Configure receiving Events for Workable into StackOne.