> ## Documentation Index
> Fetch the complete documentation index at: https://botpress.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Workable

> Add a bot to Workable using the official integration.

{/* vale on */}

[Open in Hub](https://studio.botpress.cloud/home?exploreHub=1\&hubItemId=intver_01KMZAWAMH776SVXW1R98ABBHP)
*v0.1.2*

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

## Setup

> [!NOTE]
>
> You will need:
>
> * A [published bot](https://botpress.com/docs/get-started/quick-start.md)
> * A [Workable account](https://id.workable.com/oidc/i/BtMboWMgw2NuejkYxadf_)

**1. 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.

**2. Get your Workable API key**

Next, get your Workable API key:

1. [Log in to your Workable dashboard](https://id.workable.com/oidc/i/BtMboWMgw2NuejkYxadf_).
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.

**3. 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**.

> [!TIP]
>
> Your integration is ready. You can use the integration's [Cards](#cards) and [Triggers](#triggers) to interact with your Workable candidates.

***

## Cards

{/* vale off */}

Here's a reference for all [Cards](https://botpress.com/docs/studio/concepts/cards/introduction.md) available with the integration:

### Create candidate in job

Create a candidate in the specified job

**input** `object`

**sourced** `boolean`

Indicates if the candidate is sourced or applied

**candidate** `object` *required*

The candidate to create

**firstName** `string` *required*

The candidate's first name

**lastName** `string` *required*

The candidate's last name

**email** `string` *required*

The candidate's email address

**headline** `string`

The candidate's headline

**summary** `string`

The summary of the candidate

**address** `string`

The candidate's address

**phone** `string`

The candidate's phone number

**coverLetter** `string`

The cover letter provided when the candidate applied

**educationEntries** `array`

A collection with education entries

**array item properties**

**degree** `string`

The graduation degree

**school** `string` *required*

The name of the school graduated

**fieldOfStudy** `string`

The field of study

**startDate** `string`

The date started

**endDate** `string`

The date ended

**experienceEntries** `array`

A collection with experience entries

**array item properties**

**title** `string` *required*

The title of the experience entry

**summary** `string`

The summary of the experience entry

**startDate** `string`

The date started

**endDate** `string`

The date ended

**company** `string`

The company name

**current** `boolean`

Indicates if currently works there

**industry** `string`

The industry of the company

**skills** `array`

A collection of skills with names

**tags** `array`

A collection of tags

**disqualified** `boolean`

Flag indicating whether the candidate is disqualified

**disqualificationReason** `string`

Reason for disqualification, if applicable

**disqualifiedAt** `string`

The timestamp the candidate was disqualified

**socialProfiles** `array`

A collection with social profiles of candidates

**array item properties**

**type** `enum\<string\>` *required*

The slug name of the social profile

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`

**username** `string`

The username of the social profile

**url** `string` *required*

Url to the candidate's social profile page

**domain** `string`

Where the candidate came from

**recruiterKey** `string`

The key corresponding to the recruiter who sourced the candidate

**resumeUrl** `string`

Url to the candidate resume

**resume** `object`

**name** `string` *required*

The name of the file

**data** `string` *required*

The base64 encoded data

**answers** `array`

A collection with answers provided

**array item properties**

**questionKey** `string` *required*

The question key

**body** `string`

The candidate's response

**checked** `boolean`

The candidate's response

**choices** `array`

The IDs of the choice(s) selected

**date** `string`

The date in ISO 8601 format

**value** `number`

The value may be an integer or a decimal number

**fileUrl** `string`

A url pointing to the candidate's answer

**data** `string`

The candidate's answer encoded in base64

**shortCode** `string` *required*

The shortcode of the job the candidate is applying to

**output** `object`

**status** `string` *required*

The status of the candidate

**candidate** `object` *required*

The candidate created

**id** `string`

The candidate identifier

**name** `string`

The candidate's full name

**firstName** `string`

The candidate's first name

**lastName** `string`

The candidate's last name

**email** `string | null`

**headline** `string | null`

**account** `object | null`

**stage** `string | null`

**stageKind** `string | null`

**disqualified** `boolean`

Flag indicating whether the candidate is disqualified

**withdrew** `boolean`

Flag indicating whether the candidate withdrew

**disqualificationReason** `string | null`

**sourced** `boolean`

Flag indicating whether the candidate has been sourced

**profileUrl** `string | null`

**domain** `string | null`

**createdAt** `string`

The creation timestamp of the candidate record

**updatedAt** `string`

The last update timestamp of the candidate record

**hiredAt** `string | null`

**address** `string | null`

**phone** `string | null`

**job** `object`

The job details

**shortCode** `string`

The job's system generated code

**title** `string`

The job title

**imageUrl** `string | null`

**disqualifiedAt** `string | null`

**outboundMailbox** `string | null`

**uploaderId** `string | null`

**coverLetter** `string | null`

**summary** `string | null`

**educationEntries** `array`

A collection with education entries

**array item properties**

**id** `string`

The education entry identifier

**degree** `string | null`

**school** `string`

The name of the school graduated

**fieldOfStudy** `string | null`

**startDate** `string | null`

**endDate** `string | null`

**experienceEntries** `array`

A collection with experience entries

**array item properties**

**id** `string`

The experience entry identifier

**title** `string`

The title of the experience entry

**summary** `string | null`

**startDate** `string | null`

**endDate** `string | null`

**company** `string | null`

**industry** `string | null`

**current** `boolean | null`

**skills** `array`

A collection of skills with names

**array item properties**

**name** `string`

**answers** `array`

A collection with answers provided

**array item properties**

**question** `object` *required*

**body** `string | null` *required*

**answer** `string | null` *required*

**resumeUrl** `string | null`

**socialProfiles** `array`

A collection with social profiles of candidates

**array item properties**

**type** `string`

The slug name of the social profile

**name** `string | null`

**username** `string | null`

**url** `string`

Url to the candidate's social profile page

**tags** `array`

A collection of tags

**location** `object | null`

**originatingCandidateId** `string | null`

### Create candidate in talent pool

Create a candidate in the talent pool

**input** `object`

**sourced** `boolean`

Indicates if the candidate is sourced or applied

**candidate** `object` *required*

The candidate to create

**firstName** `string` *required*

The candidate's first name

**lastName** `string` *required*

The candidate's last name

**email** `string` *required*

The candidate's email address

**headline** `string`

The candidate's headline

**summary** `string`

The summary of the candidate

**address** `string`

The candidate's address

**phone** `string`

The candidate's phone number

**coverLetter** `string`

The cover letter provided when the candidate applied

**educationEntries** `array`

A collection with education entries

**array item properties**

**degree** `string`

The graduation degree

**school** `string` *required*

The name of the school graduated

**fieldOfStudy** `string`

The field of study

**startDate** `string`

The date started

**endDate** `string`

The date ended

**experienceEntries** `array`

A collection with experience entries

**array item properties**

**title** `string` *required*

The title of the experience entry

**summary** `string`

The summary of the experience entry

**startDate** `string`

The date started

**endDate** `string`

The date ended

**company** `string`

The company name

**current** `boolean`

Indicates if currently works there

**industry** `string`

The industry of the company

**skills** `array`

A collection of skills with names

**tags** `array`

A collection of tags

**disqualified** `boolean`

Flag indicating whether the candidate is disqualified

**disqualificationReason** `string`

Reason for disqualification, if applicable

**disqualifiedAt** `string`

The timestamp the candidate was disqualified

**socialProfiles** `array`

A collection with social profiles of candidates

**array item properties**

**type** `enum\<string\>` *required*

The slug name of the social profile

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`

**username** `string`

The username of the social profile

**url** `string` *required*

Url to the candidate's social profile page

**domain** `string`

Where the candidate came from

**recruiterKey** `string`

The key corresponding to the recruiter who sourced the candidate

**resumeUrl** `string`

Url to the candidate resume

**resume** `object`

**name** `string` *required*

The name of the file

**data** `string` *required*

The base64 encoded data

**output** `object`

**status** `string` *required*

The status of the candidate

**candidate** `object` *required*

The candidate created

**id** `string`

The candidate identifier

**name** `string`

The candidate's full name

**firstName** `string`

The candidate's first name

**lastName** `string`

The candidate's last name

**email** `string | null`

**headline** `string | null`

**account** `object | null`

**stage** `string | null`

**stageKind** `string | null`

**disqualified** `boolean`

Flag indicating whether the candidate is disqualified

**withdrew** `boolean`

Flag indicating whether the candidate withdrew

**disqualificationReason** `string | null`

**sourced** `boolean`

Flag indicating whether the candidate has been sourced

**profileUrl** `string | null`

**domain** `string | null`

**createdAt** `string`

The creation timestamp of the candidate record

**updatedAt** `string`

The last update timestamp of the candidate record

**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`

A collection with education entries

**array item properties**

**id** `string`

The education entry identifier

**degree** `string | null`

**school** `string`

The name of the school graduated

**fieldOfStudy** `string | null`

**startDate** `string | null`

**endDate** `string | null`

**experienceEntries** `array`

A collection with experience entries

**array item properties**

**id** `string`

The experience entry identifier

**title** `string`

The title of the experience entry

**summary** `string | null`

**startDate** `string | null`

**endDate** `string | null`

**company** `string | null`

**industry** `string | null`

**current** `boolean | null`

**skills** `array`

A collection of skills with names

**array item properties**

**name** `string`

**answers** `array`

A collection with answers provided

**array item properties**

**question** `object` *required*

**body** `string | null` *required*

**answer** `string | null` *required*

**resumeUrl** `string | null`

**socialProfiles** `array`

A collection with social profiles of candidates

**array item properties**

**type** `string`

The slug name of the social profile

**name** `string | null`

**username** `string | null`

**url** `string`

Url to the candidate's social profile page

**tags** `array`

A collection of tags

**location** `object | null`

**originatingCandidateId** `string | null`

**talentPool** `object` *required*

The talent pool fields

**talentPoolId** `number` *required*

The ID of the candidate in the talent pool

### Get candidate

Get a candidate by ID

**input** `object`

**id** `string` *required*

The candidate's ID

**output** `object`

**candidate** `object`

The candidate found

**id** `string`

The candidate identifier

**name** `string`

The candidate's full name

**firstName** `string`

The candidate's first name

**lastName** `string`

The candidate's last name

**email** `string | null`

**headline** `string | null`

**account** `object | null`

**stage** `string | null`

**stageKind** `string | null`

**disqualified** `boolean`

Flag indicating whether the candidate is disqualified

**withdrew** `boolean`

Flag indicating whether the candidate withdrew

**disqualificationReason** `string | null`

**sourced** `boolean`

Flag indicating whether the candidate has been sourced

**profileUrl** `string | null`

**domain** `string | null`

**createdAt** `string`

The creation timestamp of the candidate record

**updatedAt** `string`

The last update timestamp of the candidate record

**hiredAt** `string | null`

**address** `string | null`

**phone** `string | null`

**job** `object`

The job details

**shortCode** `string`

The job's system generated code

**title** `string`

The job title

**imageUrl** `string | null`

**disqualifiedAt** `string | null`

**outboundMailbox** `string | null`

**uploaderId** `string | null`

**coverLetter** `string | null`

**summary** `string | null`

**educationEntries** `array`

A collection with education entries

**array item properties**

**id** `string`

The education entry identifier

**degree** `string | null`

**school** `string`

The name of the school graduated

**fieldOfStudy** `string | null`

**startDate** `string | null`

**endDate** `string | null`

**experienceEntries** `array`

A collection with experience entries

**array item properties**

**id** `string`

The experience entry identifier

**title** `string`

The title of the experience entry

**summary** `string | null`

**startDate** `string | null`

**endDate** `string | null`

**company** `string | null`

**industry** `string | null`

**current** `boolean | null`

**skills** `array`

A collection of skills with names

**array item properties**

**name** `string`

**answers** `array`

A collection with answers provided

**array item properties**

**question** `object` *required*

**body** `string | null` *required*

**answer** `string | null` *required*

**resumeUrl** `string | null`

**socialProfiles** `array`

A collection with social profiles of candidates

**array item properties**

**type** `string`

The slug name of the social profile

**name** `string | null`

**username** `string | null`

**url** `string`

Url to the candidate's social profile page

**tags** `array`

A collection of tags

**location** `object | null`

**originatingCandidateId** `string | null`

### Get job questions

Get the questions associated with a job offer

**input** `object`

**shortCode** `string` *required*

The job's system generated code

**output** `object`

**questions** `array` *required*

The questions

**array item properties**

**id** `string` *required*

The question's id

**body** `string` *required*

The question's body

**type** `enum\<string\>` *required*

The question's type

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

**required** `boolean` *required*

specifies wether providing an answer to the question is required

**singleAnswer** `boolean`

Wether the question allows for multiple answers. Defined only for type multiple\_choice.

**choices** `array`

An array specifying the possible answers. Defined only for types multiple\_choice and dropdown.

**array item properties**

**id** `string` *required*

The choice's id

**body** `string` *required*

The choice's text

**supportedFileTypes** `array`

An array specifying the accepted file types. Defined only if question type is file.

**maxFileSize** `number`

The maximum file size in bytes. Defined only if question is file

### List candidates

List the candidates for a job

**input** `object`

**email** `string`

The email of the candidate to filter by

**shortCode** `string`

The job's system generated code

**stage** `string`

The job's stage slug, can be retrieved from the '/stages' endpoint

**limit** `number`

Specifies the number of candidates to try and retrieve per page

**nextToken** `string`

Returns results with an ID greater than or equal to the specified ID

**createdAfter** `string`

Returns results created after the specified timestamp

**updatedAfter** `string`

Returns results updated after the specified timestamp

**output** `object`

**candidates** `array` *required*

The array of candidates

**array item properties**

**id** `string`

The candidate identifier

**name** `string`

The candidate's full name

**firstName** `string`

The candidate's first name

**lastName** `string`

The candidate's last name

**email** `string | null`

**headline** `string | null`

**account** `object | null`

**stage** `string | null`

**stageKind** `string | null`

**disqualified** `boolean`

Flag indicating whether the candidate is disqualified

**withdrew** `boolean`

Flag indicating whether the candidate withdrew

**disqualificationReason** `string | null`

**sourced** `boolean`

Flag indicating whether the candidate has been sourced

**profileUrl** `string | null`

**domain** `string | null`

**createdAt** `string`

The creation timestamp of the candidate record

**updatedAt** `string`

The last update timestamp of the candidate record

**hiredAt** `string | null`

**address** `string | null`

**phone** `string | null`

**job** `object`

The job details

**shortCode** `string`

The job's system generated code

**title** `string`

The job title

**nextToken** `string`

The token for the next page of results

### Update candidate

Update an existing candidate. Omitted fields will remain unchanged.

**input** `object`

**id** `string` *required*

The candidate to update's id

**candidate** `object` *required*

The candidate to update

**firstName** `string`

The candidate's first name

**lastName** `string`

The candidate's last name

**email** `string`

The candidate's email address

**headline** `string`

The candidate's headline

**summary** `string`

The summary of the candidate

**address** `string`

The candidate's address

**phone** `string`

The candidate's phone number

**coverLetter** `string`

The cover letter provided when the candidate applied

**educationEntries** `array`

Existing entries will be deleted if not included in the new array.

**array item properties**

**id** `string`

The education entry identifier

**degree** `string`

The graduation degree

**school** `string` *required*

The name of the school graduated

**fieldOfStudy** `string`

The field of study

**startDate** `string`

The date started

**endDate** `string`

The date ended

**experienceEntries** `array`

Existing entries will be deleted if not included in the new array.

**array item properties**

**id** `string`

The experience entry identifier

**title** `string` *required*

The title of the experience entry

**summary** `string`

The summary of the experience entry

**startDate** `string`

The date started

**endDate** `string`

The date ended

**company** `string`

The company name

**industry** `string`

The industry of the company

**current** `boolean`

Indicates if currently works there

**skills** `array`

A collection of skills with names

**tags** `array`

A collection of tags

**socialProfiles** `array`

Existing profiles will be deleted if not included in the new array.

**array item properties**

**type** `enum\<string\>` *required*

The slug name of the social profile

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`

**name** `string`

The full name of the social profile

**username** `string`

The username of the social profile

**url** `string` *required*

Url to the candidate's social profile page

**resumeUrl** `string`

Url to the candidate resume

**resume** `object`

**name** `string` *required*

The name of the file

**data** `string` *required*

The base64 encoded data

**textingConsent** `enum\<string\>`

Available options: `forced`, `declined`

**imageUrl** `string`

A url pointing to the candidate's image

**imageSource** `enum\<string\>`

The source of the image (if not provided by the candidate)

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`

**name** `string`

The candidate's image name

**data** `string`

The candidate's image encodede in base64

**source** `enum\<string\>`

The image source

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** `object`

**candidate** `object` *required*

The candidate updated

**id** `string`

The candidate identifier

**name** `string`

The candidate's full name

**firstName** `string`

The candidate's first name

**lastName** `string`

The candidate's last name

**email** `string | null`

**headline** `string | null`

**account** `object | null`

**stage** `string | null`

**stageKind** `string | null`

**disqualified** `boolean`

Flag indicating whether the candidate is disqualified

**withdrew** `boolean`

Flag indicating whether the candidate withdrew

**disqualificationReason** `string | null`

**sourced** `boolean`

Flag indicating whether the candidate has been sourced

**profileUrl** `string | null`

**domain** `string | null`

**createdAt** `string`

The creation timestamp of the candidate record

**updatedAt** `string`

The last update timestamp of the candidate record

**hiredAt** `string | null`

**address** `string | null`

**phone** `string | null`

**job** `object`

The job details

**shortCode** `string`

The job's system generated code

**title** `string`

The job title

**imageUrl** `string | null`

**disqualifiedAt** `string | null`

**outboundMailbox** `string | null`

**uploaderId** `string | null`

**coverLetter** `string | null`

**summary** `string | null`

**educationEntries** `array`

A collection with education entries

**array item properties**

**id** `string`

The education entry identifier

**degree** `string | null`

**school** `string`

The name of the school graduated

**fieldOfStudy** `string | null`

**startDate** `string | null`

**endDate** `string | null`

**experienceEntries** `array`

A collection with experience entries

**array item properties**

**id** `string`

The experience entry identifier

**title** `string`

The title of the experience entry

**summary** `string | null`

**startDate** `string | null`

**endDate** `string | null`

**company** `string | null`

**industry** `string | null`

**current** `boolean | null`

**skills** `array`

A collection of skills with names

**array item properties**

**name** `string`

**answers** `array`

A collection with answers provided

**array item properties**

**question** `object` *required*

**body** `string | null` *required*

**answer** `string | null` *required*

**resumeUrl** `string | null`

**socialProfiles** `array`

A collection with social profiles of candidates

**array item properties**

**type** `string`

The slug name of the social profile

**name** `string | null`

**username** `string | null`

**url** `string`

Url to the candidate's social profile page

**tags** `array`

A collection of tags

**location** `object | null`

**originatingCandidateId** `string | null`

***

## Triggers

{/* vale off */}

Here's a reference for all [Triggers](https://botpress.com/docs/studio/concepts/triggers.md) available with the integration:

> [!TIP]
>
> You can access data returned from any of these Triggers by reading `event.payload` after the Trigger fires.

### Candidate Created

A candidate was created on a job.

**payload** `object`

Event data

**firedAt** `string` *required*

The date and time the event was triggered

**id** `string` *required*

The event identifier

**resourceType** `string` *required*

The type of the payload resource

**data** `object` *required*

The candidate that was created

**id** `string`

The candidate identifier

**name** `string`

The candidate's full name

**firstName** `string`

The candidate's first name

**lastName** `string`

The candidate's last name

**email** `string | null`

**headline** `string | null`

**account** `object | null`

**stage** `string | null`

**stageKind** `string | null`

**disqualified** `boolean`

Flag indicating whether the candidate is disqualified

**withdrew** `boolean`

Flag indicating whether the candidate withdrew

**disqualificationReason** `string | null`

**sourced** `boolean`

Flag indicating whether the candidate has been sourced

**profileUrl** `string | null`

**domain** `string | null`

**createdAt** `string`

The creation timestamp of the candidate record

**updatedAt** `string`

The last update timestamp of the candidate record

**hiredAt** `string | null`

**address** `string | null`

**phone** `string | null`

**job** `object`

The job details

**shortCode** `string`

The job's system generated code

**title** `string`

The job title

**eventType** `string` *required*

The type of event

### Candidate Moved

A candidate was moved on a job.

**payload** `object`

Event data

**firedAt** `string` *required*

The date and time the event was triggered

**id** `string` *required*

The event identifier

**resourceType** `string` *required*

The type of the payload resource

**data** `object` *required*

The candidate that was moved

**id** `string`

The candidate identifier

**name** `string`

The candidate's full name

**firstName** `string`

The candidate's first name

**lastName** `string`

The candidate's last name

**email** `string | null`

**headline** `string | null`

**account** `object | null`

**stage** `string | null`

**stageKind** `string | null`

**disqualified** `boolean`

Flag indicating whether the candidate is disqualified

**withdrew** `boolean`

Flag indicating whether the candidate withdrew

**disqualificationReason** `string | null`

**sourced** `boolean`

Flag indicating whether the candidate has been sourced

**profileUrl** `string | null`

**domain** `string | null`

**createdAt** `string`

The creation timestamp of the candidate record

**updatedAt** `string`

The last update timestamp of the candidate record

**hiredAt** `string | null`

**address** `string | null`

**phone** `string | null`

**job** `object`

The job details

**shortCode** `string`

The job's system generated code

**title** `string`

The job title

**eventType** `string` *required*

The type of event


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.