Workable

Open in Hubv 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

Input:

Show input fields

candidate

object

required

Show child attributes

Show array item properties

type

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

Output:

Show output

candidate

object

required

Show child attributes

string | null

headline

string | null

account

object | null

stage

string | null

stageKind

string | null

disqualificationReason

string | null

profileUrl

string | null

domain

string | null

hiredAt

string | null

address

string | null

phone

string | null

imageUrl

string | null

disqualifiedAt

string | null

outboundMailbox

string | null

uploaderId

string | null

coverLetter

string | null

summary

string | null

educationEntries

array

Show array item properties

degree

string | null

fieldOfStudy

string | null

startDate

string | null

endDate

string | null

experienceEntries

array

Show array item properties

summary

string | null

startDate

string | null

endDate

string | null

company

string | null

industry

string | null

current

boolean | null

skills

array

Show array item properties

name

string

answers

array

Show array item properties

question

object

required

Show child attributes

body

string | null

required

answer

string | null

required

resumeUrl

string | null

Show array item properties

name

string | null

username

string | null

location

object | null

originatingCandidateId

string | null

Create candidate in talent pool

Input:

Show input fields

candidate

object

required

Show child attributes

Show array item properties

type

enum<string>

required

Output:

Show output

candidate

object

required

Show child attributes

string | null

headline

string | null

account

object | null

stage

string | null

stageKind

string | null

disqualificationReason

string | null

profileUrl

string | null

domain

string | null

hiredAt

string | null

address

string | null

phone

string | null

imageUrl

string | null

disqualifiedAt

string | null

outboundMailbox

string | null

uploaderId

string | null

coverLetter

string | null

summary

string | null

educationEntries

array

Show array item properties

degree

string | null

fieldOfStudy

string | null

startDate

string | null

endDate

string | null

experienceEntries

array

Show array item properties

summary

string | null

startDate

string | null

endDate

string | null

company

string | null

industry

string | null

current

boolean | null

skills

array

Show array item properties

name

string

answers

array

Show array item properties

question

object

required

Show child attributes

body

string | null

required

answer

string | null

required

resumeUrl

string | null

Show array item properties

name

string | null

username

string | null

location

object | null

originatingCandidateId

string | null

Get candidate

Input: Output:

Show output

candidate

object

Show child attributes

string | null

headline

string | null

account

object | null

stage

string | null

stageKind

string | null

disqualificationReason

string | null

profileUrl

string | null

domain

string | null

hiredAt

string | null

address

string | null

phone

string | null

imageUrl

string | null

disqualifiedAt

string | null

outboundMailbox

string | null

uploaderId

string | null

coverLetter

string | null

summary

string | null

educationEntries

array

Show array item properties

degree

string | null

fieldOfStudy

string | null

startDate

string | null

endDate

string | null

experienceEntries

array

Show array item properties

summary

string | null

startDate

string | null

endDate

string | null

company

string | null

industry

string | null

current

boolean | null

skills

array

Show array item properties

name

string

answers

array

Show array item properties

question

object

required

Show child attributes

body

string | null

required

answer

string | null

required

resumeUrl

string | null

Show array item properties

name

string | null

username

string | null

location

object | null

originatingCandidateId

string | null

Get job questions

Input: Output:

Show output

questions

array

required

Show array item properties

type

enum<string>

required

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

List candidates

Input: Output:

Show output

candidates

array

required

Show array item properties

string | null

headline

string | null

account

object | null

stage

string | null

stageKind

string | null

disqualificationReason

string | null

profileUrl

string | null

domain

string | null

hiredAt

string | null

address

string | null

phone

string | null

Update candidate

Input:

Show input fields

candidate

object

required

Show child attributes

Show array item properties

type

enum<string>

required

Available options: forced, declined

imageSource

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

image

object

Show child attributes

source

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

Output:

Show output

candidate

object

required

Show child attributes

string | null

headline

string | null

account

object | null

stage

string | null

stageKind

string | null

disqualificationReason

string | null

profileUrl

string | null

domain

string | null

hiredAt

string | null

address

string | null

phone

string | null

imageUrl

string | null

disqualifiedAt

string | null

outboundMailbox

string | null

uploaderId

string | null

coverLetter

string | null

summary

string | null

educationEntries

array

Show array item properties

degree

string | null

fieldOfStudy

string | null

startDate

string | null

endDate

string | null

experienceEntries

array

Show array item properties

summary

string | null

startDate

string | null

endDate

string | null

company

string | null

industry

string | null

current

boolean | null

skills

array

Show array item properties

name

string

answers

array

Show array item properties

question

object

required

Show child attributes

body

string | null

required

answer

string | null

required

resumeUrl

string | null

Show array item properties

name

string | null

username

string | null

location

object | null

originatingCandidateId

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

payload

object

Show child attributes

data

object

required

Show child attributes

string | null

headline

string | null

account

object | null

stage

string | null

stageKind

string | null

disqualificationReason

string | null

profileUrl

string | null

domain

string | null

hiredAt

string | null

address

string | null

phone

string | null

Candidate Moved

payload

object

Show child attributes

data

object

required

Show child attributes

string | null

headline

string | null

account

object | null

stage

string | null

stageKind

string | null

disqualificationReason

string | null

profileUrl

string | null

domain

string | null

hiredAt

string | null

address

string | null

phone

string | null

Get started

Studio

Integrations

Webchat

For developers

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

Get started

Studio

Integrations

Webchat

For developers

​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