Docs

Workable

Add a bot to Workable using the official integration.

The official Workable integration allows your bot to create and manage your Workable candidates.

Setup

Install the integration in Botpress

First, install the integration to your bot:

  1. In Botpress Studio, select Explore Hub in the upper-right corner.
  2. Search for the Workable integration, then select Install Integration.
  3. Fill in the Account subdomain field with your company’s subdomain (https://mycompany.workable.com)
  4. Leave the API access token field empty for now—you’ll come back to them after getting your Workable API key.

Get your Workable API key

Next, get your Workable API key:

  1. Log in to your Workable dashboard.
  2. Select your profile picture and go to Settings.
  3. In the left navigation bar, go to Integrations > Apps.
  4. Scroll to API Access Tokens, then select Generate API token.
  5. Add the r_candidates and w_candidates scopes.
  6. Copy the generated token.

Configure the integration in Botpress

Now, you can finish setting up the integration in Botpress:

  1. In the integration’s API access token field, paste your Workable API key.
  2. Select Save Configuration.

Cards

Create candidate in job

Create a candidate in the specified job

inputobject
outputobject

Create candidate in talent pool

Create a candidate in the talent pool

inputobject
outputobject

Get candidate

Get a candidate by ID

inputobject
outputobject

Get job questions

Get the questions associated with a job offer

inputobject
outputobject

List candidates

List the candidates for a job

inputobject
outputobject

Update candidate

Update an existing candidate. Omitted fields will remain unchanged.

inputobject
outputobject

Triggers

Candidate Created

A candidate was created on a job.

payloadobject

Candidate Moved

A candidate was moved on a job.

payloadobject