Workable

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

Setup

You will need:

A published bot
A Workable account

Install the integration in Botpress

First, install the integration to your bot:

In Botpress Studio, select Explore Hub in the upper-right corner.
Search for the Workable integration, then select Install Integration.
Fill in the Account subdomain field with your company’s subdomain (https://mycompany.workable.com)
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:

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

Configure the integration in Botpress

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

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

Your integration is ready. You can use the integration’s Cards and Triggers to interact with your Workable candidates.

Cards

Here’s a reference for all Cards available with the integration:

Create candidate in job

object

Show child attributes

object

required

Show child attributes

Show array item properties

enum<string>

required

Available options: academiaedu, angellist, behance, bitbucket, blogger, crunchbase, dandyid, delicious, deviantart, digg, doyoubuzz, dribble, dribbble, econsultancy, facebook, flavorsme, flickr, fullcontact, getglue, gist, github, goodreads, googleplus, gravatar, hackernews, hiim, klout, lanyrd, linkedin, myspace, ohloh, orkut, pinterest, quora, reddit, scribd, slideshare, stackexchange, stackoverflow, tumblr, twitter, typepad, vk, wordpress, xing

object

Show child attributes

object

required

Show child attributes

string | null

object | null

string | null

array

Show array item properties

string | null

array

Show array item properties

string | null

boolean | null

array

Show array item properties

string

array

Show array item properties

object

required

Show child attributes

string | null

required

string | null

required

string | null

Show array item properties

string | null

object | null

string | null

Create candidate in talent pool

object

Show child attributes

object

required

Show child attributes

Show array item properties

enum<string>

required

object

Show child attributes

object

required

Show child attributes

string | null

object | null

string | null

array

Show array item properties

string | null

array

Show array item properties

string | null

boolean | null

array

Show array item properties

string

array

Show array item properties

object

required

Show child attributes

string | null

required

string | null

required

string | null

Show array item properties

string | null

object | null

string | null

Get candidate

object

Show child attributes

object

Show child attributes

string | null

object | null

string | null

array

Show array item properties

string | null

array

Show array item properties

string | null

boolean | null

array

Show array item properties

string

array

Show array item properties

object

required

Show child attributes

string | null

required

string | null

required

string | null

Show array item properties

string | null

object | null

string | null

Get job questions

object

Show child attributes

array

required

Show array item properties

enum<string>

required

Available options: free_text, multiple_choice, boolean, dropdown, numeric, date, file

List candidates

object

Show child attributes

array

required

Show array item properties

string | null

object | null

string | null

Update candidate

object

Show child attributes

object

required

Show child attributes

Show array item properties

enum<string>

required

Available options: forced, declined

enum<string>

Available options: academiaedu, angellist, behance, bitbucket, blogger, crunchbase, dandyid, delicious, deviantart, digg, doyoubuzz, dribble, dribbble, econsultancy, facebook, flavorsme, flickr, fullcontact, getglue, gist, github, goodreads, googleplus, gravatar, hackernews, hiim, klout, lanyrd, linkedin, myspace, ohloh, orkut, pinterest, quora, reddit, scribd, skype, slideshare, stackexchange, stackoverflow, tumblr, twitter, typepad, vk, wordpress, xing

object

Show child attributes

enum<string>

Available options: academiaedu, angellist, behance, bitbucket, blogger, crunchbase, dandyid, delicious, deviantart, digg, doyoubuzz, dribble, dribbble, econsultancy, facebook, flavorsme, flickr, fullcontact, getglue, gist, github, goodreads, googleplus, gravatar, hackernews, hiim, klout, lanyrd, linkedin, myspace, ohloh, orkut, pinterest, quora, reddit, scribd, skype, slideshare, stackexchange, stackoverflow, tumblr, twitter, typepad, vk, wordpress, xing

object

Show child attributes

object

required

Show child attributes

string | null

object | null

string | null

array

Show array item properties

string | null

array

Show array item properties

string | null

boolean | null

array

Show array item properties

string

array

Show array item properties

object

required

Show child attributes

string | null

required

string | null

required

string | null

Show array item properties

string | null

object | null

string | null

Triggers

Here’s a reference for all Triggers available with the integration:

You can access data returned from any of these Triggers by reading event.payload after the Trigger fires.

Candidate Created

object

Show child attributes

object

required

Show child attributes

string | null

object | null

string | null

Candidate Moved

object

Show child attributes

object

required

Show child attributes

string | null

object | null

string | null

Get started

ADK

Studio

Integrations

Webchat

Desk

Setup

Cards

Create candidate in job

Create candidate in talent pool

Get candidate

Get job questions

List candidates

Update candidate

Triggers

Candidate Created

Candidate Moved

​Setup

​Cards

​Create candidate in job

​Create candidate in talent pool

​Get candidate

​Get job questions

​List candidates

​Update candidate

​Triggers

​Candidate Created

​Candidate Moved

Setup

Cards

Create candidate in job

Create candidate in talent pool

Get candidate

Get job questions

List candidates

Update candidate

Triggers

Candidate Created

Candidate Moved