Integrate Ashby into the workflow. Manage candidates (list, get, create, update, search, tag), applications (list, get, create, change stage), jobs (list, get), job postings (list, get), offers (list, get), notes (list, create), interviews (list), and reference data (sources, tags, archive reasons, custom fields, departments, locations, openings, users).
Adds a tag to a candidate in Ashby and returns the updated candidate.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
candidateId | string | Yes | The UUID of the candidate to add the tag to |
tagId | string | Yes | The UUID of the tag to add |
| Parameter | Type | Description |
|---|
id | string | Candidate UUID |
name | string | Full name |
primaryEmailAddress | object | Primary email contact info |
primaryPhoneNumber | object | Primary phone contact info |
emailAddresses | array | All email addresses |
phoneNumbers | array | All phone numbers |
socialLinks | array | Social network links |
linkedInUrl | string | LinkedIn profile URL |
githubUrl | string | GitHub profile URL |
profileUrl | string | URL to the candidate Ashby profile |
position | string | Current position or title |
company | string | Current company |
school | string | Most recent school |
timezone | string | Candidate timezone |
location | object | Candidate location |
tags | array | Tags applied to the candidate |
applicationIds | array | IDs of associated applications |
customFields | array | Custom field values |
resumeFileHandle | object | Resume file reference |
fileHandles | array | All uploaded file references |
source | object | Attribution source |
creditedToUser | object | User credited with sourcing |
fraudStatus | string | Fraud detection status |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last update timestamp |
Moves an application to a different interview stage. Requires an archive reason when moving to an Archived stage.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
applicationId | string | Yes | The UUID of the application to update the stage of |
interviewStageId | string | Yes | The UUID of the interview stage to move the application to |
archiveReasonId | string | No | Archive reason UUID. Required when moving to an Archived stage, ignored otherwise |
| Parameter | Type | Description |
|---|
id | string | Application UUID |
status | string | Status (Active, Hired, Archived, Lead) |
customFields | array | Custom field values |
candidate | object | Associated candidate summary |
currentInterviewStage | object | Current interview stage |
source | object | Attribution source |
archiveReason | object | Reason for archival (when archived) |
archivedAt | string | ISO 8601 archive timestamp |
job | object | Associated job summary |
creditedToUser | object | User credited with the application |
hiringTeam | array | Hiring team members |
appliedViaJobPostingId | string | Job posting UUID the candidate applied through |
submitterClientIp | string | Submitter IP address |
submitterUserAgent | string | Submitter browser user agent |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last update timestamp |
applicationHistory | array | Stage history (only populated by application.info, empty for list endpoints) |
Creates a new application for a candidate on a job. Optionally specify interview plan, stage, source, and credited user.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
candidateId | string | Yes | The UUID of the candidate to consider for the job |
jobId | string | Yes | The UUID of the job to consider the candidate for |
interviewPlanId | string | No | UUID of the interview plan to use (defaults to the job default plan) |
interviewStageId | string | No | UUID of the interview stage to place the application in (defaults to first Lead stage) |
sourceId | string | No | UUID of the source to set on the application |
creditedToUserId | string | No | UUID of the user the application is credited to |
createdAt | string | No | ISO 8601 timestamp to set as the application creation date (defaults to now) |
| Parameter | Type | Description |
|---|
id | string | Application UUID |
status | string | Status (Active, Hired, Archived, Lead) |
customFields | array | Custom field values |
candidate | object | Associated candidate summary |
currentInterviewStage | object | Current interview stage |
source | object | Attribution source |
archiveReason | object | Reason for archival (when archived) |
archivedAt | string | ISO 8601 archive timestamp |
job | object | Associated job summary |
creditedToUser | object | User credited with the application |
hiringTeam | array | Hiring team members |
appliedViaJobPostingId | string | Job posting UUID the candidate applied through |
submitterClientIp | string | Submitter IP address |
submitterUserAgent | string | Submitter browser user agent |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last update timestamp |
applicationHistory | array | Stage history (only populated by application.info, empty for list endpoints) |
Creates a new candidate record in Ashby.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
name | string | Yes | The candidate full name |
email | string | No | Primary email address for the candidate |
phoneNumber | string | No | Primary phone number for the candidate |
linkedInUrl | string | No | LinkedIn profile URL |
githubUrl | string | No | GitHub profile URL |
website | string | No | Personal website URL |
sourceId | string | No | UUID of the source to attribute the candidate to |
creditedToUserId | string | No | UUID of the Ashby user to credit with sourcing this candidate |
createdAt | string | No | Backdated creation timestamp in ISO 8601 (e.g. 2024-01-01T00:00:00Z). Defaults to now. |
alternateEmailAddresses | json | No | Array of additional email address strings to add to the candidate, e.g. ["a@x.com","b@y.com"] |
| Parameter | Type | Description |
|---|
id | string | Candidate UUID |
name | string | Full name |
primaryEmailAddress | object | Primary email contact info |
primaryPhoneNumber | object | Primary phone contact info |
emailAddresses | array | All email addresses |
phoneNumbers | array | All phone numbers |
socialLinks | array | Social network links |
linkedInUrl | string | LinkedIn profile URL |
githubUrl | string | GitHub profile URL |
profileUrl | string | URL to the candidate Ashby profile |
position | string | Current position or title |
company | string | Current company |
school | string | Most recent school |
timezone | string | Candidate timezone |
location | object | Candidate location |
tags | array | Tags applied to the candidate |
applicationIds | array | IDs of associated applications |
customFields | array | Custom field values |
resumeFileHandle | object | Resume file reference |
fileHandles | array | All uploaded file references |
source | object | Attribution source |
creditedToUser | object | User credited with sourcing |
fraudStatus | string | Fraud detection status |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last update timestamp |
Creates a note on a candidate in Ashby. Supports plain text and HTML content (bold, italic, underline, links, lists, code).
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
candidateId | string | Yes | The UUID of the candidate to add the note to |
note | string | Yes | The note content. If noteType is text/html, supports: <b>, <i>, <u>, <a>, <ul>, <ol>, <li>, <code>, <pre> |
noteType | string | No | Content type of the note: text/plain (default) or text/html |
sendNotifications | boolean | No | Whether to send notifications to subscribed users (default false) |
isPrivate | boolean | No | Whether the note is private (only visible to the author) |
createdAt | string | No | Backdated creation timestamp in ISO 8601 (e.g. 2024-01-01T00:00:00Z). Defaults to now. |
| Parameter | Type | Description |
|---|
id | string | Created note UUID |
createdAt | string | ISO 8601 creation timestamp |
isPrivate | boolean | Whether the note is private |
content | string | Note content |
author | object | Author of the note |
Retrieves full details about a single application by its ID.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
applicationId | string | Yes | The UUID of the application to fetch |
| Parameter | Type | Description |
|---|
id | string | Application UUID |
status | string | Status (Active, Hired, Archived, Lead) |
customFields | array | Custom field values |
candidate | object | Associated candidate summary |
currentInterviewStage | object | Current interview stage |
source | object | Attribution source |
archiveReason | object | Reason for archival (when archived) |
archivedAt | string | ISO 8601 archive timestamp |
job | object | Associated job summary |
creditedToUser | object | User credited with the application |
hiringTeam | array | Hiring team members |
appliedViaJobPostingId | string | Job posting UUID the candidate applied through |
submitterClientIp | string | Submitter IP address |
submitterUserAgent | string | Submitter browser user agent |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last update timestamp |
applicationHistory | array | Stage history (only populated by application.info, empty for list endpoints) |
Retrieves full details about a single candidate by their ID.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
candidateId | string | Yes | The UUID of the candidate to fetch |
| Parameter | Type | Description |
|---|
id | string | Candidate UUID |
name | string | Full name |
primaryEmailAddress | object | Primary email contact info |
primaryPhoneNumber | object | Primary phone contact info |
emailAddresses | array | All email addresses |
phoneNumbers | array | All phone numbers |
socialLinks | array | Social network links |
linkedInUrl | string | LinkedIn profile URL |
githubUrl | string | GitHub profile URL |
profileUrl | string | URL to the candidate Ashby profile |
position | string | Current position or title |
company | string | Current company |
school | string | Most recent school |
timezone | string | Candidate timezone |
location | object | Candidate location |
tags | array | Tags applied to the candidate |
applicationIds | array | IDs of associated applications |
customFields | array | Custom field values |
resumeFileHandle | object | Resume file reference |
fileHandles | array | All uploaded file references |
source | object | Attribution source |
creditedToUser | object | User credited with sourcing |
fraudStatus | string | Fraud detection status |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last update timestamp |
Retrieves full details about a single job by its ID.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
jobId | string | Yes | The UUID of the job to fetch |
| Parameter | Type | Description |
|---|
id | string | Job UUID |
title | string | Job title |
confidential | boolean | Whether the job is confidential |
status | string | Status (Open, Closed, Draft, Archived) |
employmentType | string | Employment type (FullTime, PartTime, Intern, Contract, Temporary) |
locationId | string | Primary location UUID |
departmentId | string | Department UUID |
defaultInterviewPlanId | string | Default interview plan UUID |
interviewPlanIds | array | All interview plan UUIDs |
customFields | array | Custom field values |
jobPostingIds | array | Associated job posting UUIDs |
customRequisitionId | string | Custom requisition identifier |
brandId | string | Brand UUID |
hiringTeam | array | Hiring team members |
author | object | Job author (creator) |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last update timestamp |
openedAt | string | ISO 8601 opened timestamp |
closedAt | string | ISO 8601 closed timestamp |
location | object | Primary location details |
openings | array | Headcount openings associated with the job |
compensation | object | Compensation tiers for the job. Only present when the request includes the compensation expand parameter. |
Retrieves full details about a single job posting by its ID.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
jobPostingId | string | Yes | The UUID of the job posting to fetch |
jobBoardId | string | No | Optional job board UUID. If omitted, returns posting for the external job board. |
expandJob | boolean | No | Whether to expand and include the related job object in the response |
| Parameter | Type | Description |
|---|
id | string | Job posting UUID |
title | string | Job posting title |
descriptionPlain | string | Full description in plain text |
descriptionHtml | string | Full description in HTML |
descriptionSocial | string | Shortened description for social sharing (max 200 chars) |
descriptionParts | object | Description broken into opening, body, and closing sections |
departmentName | string | Department name |
teamName | string | Team name |
teamNameHierarchy | array | Hierarchy of team names from root to team |
jobId | string | Associated job UUID |
locationName | string | Primary location name |
locationIds | object | Primary and secondary location UUIDs |
address | object | Postal address of the posting location |
isRemote | boolean | Whether the posting is remote |
workplaceType | string | Workplace type (OnSite, Remote, Hybrid) |
employmentType | string | Employment type (FullTime, PartTime, Intern, Contract, Temporary) |
isListed | boolean | Whether publicly listed on the job board |
suppressDescriptionOpening | boolean | Whether the theme opening is hidden on this posting |
suppressDescriptionClosing | boolean | Whether the theme closing is hidden on this posting |
publishedDate | string | ISO 8601 published date |
applicationDeadline | string | ISO 8601 application deadline |
externalLink | string | External link to the job posting |
applyLink | string | Direct apply link |
compensation | object | Compensation details for the posting |
applicationLimitCalloutHtml | string | HTML callout shown when the application limit is reached |
updatedAt | string | ISO 8601 last update timestamp |
job | object | The expanded job object, only present when the request was made with expandJob=true |
Retrieves full details about a single offer by its ID.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
offerId | string | Yes | The UUID of the offer to fetch |
| Parameter | Type | Description |
|---|
id | string | Offer UUID |
decidedAt | string | Timestamp the offer was decided |
applicationId | string | Associated application UUID |
acceptanceStatus | string | Acceptance status (Accepted, Declined, Pending, etc.) |
offerStatus | string | Offer status (e.g. WaitingOnCandidateResponse, CandidateAccepted) |
latestVersion | object | Most recent version of the offer with pricing and metadata |
Lists all applications in an Ashby organization with pagination and optional filters for status, job, and creation date.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
cursor | string | No | Opaque pagination cursor from a previous response nextCursor value |
perPage | number | No | Number of results per page (default 100) |
status | string | No | Filter by application status: Active, Hired, Archived, or Lead |
jobId | string | No | Filter applications by a specific job UUID |
createdAfter | string | No | Filter to applications created after this ISO 8601 timestamp (e.g. 2024-01-01T00:00:00Z) |
| Parameter | Type | Description |
|---|
applications | array | List of applications |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
Lists all archive reasons configured in Ashby.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
includeArchived | boolean | No | Whether to include archived archive reasons in the response (default false) |
| Parameter | Type | Description |
|---|
archiveReasons | array | List of archive reasons |
Lists all candidate tags configured in Ashby.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
includeArchived | boolean | No | Whether to include archived candidate tags (default false) |
cursor | string | No | Opaque pagination cursor from a previous response nextCursor value |
syncToken | string | No | Sync token from a previous response to fetch only changed results |
perPage | number | No | Number of results per page (default 100) |
| Parameter | Type | Description |
|---|
tags | array | List of candidate tags |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
syncToken | string | Sync token to use for incremental updates in future requests |
Lists all candidates in an Ashby organization with cursor-based pagination.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
cursor | string | No | Opaque pagination cursor from a previous response nextCursor value |
perPage | number | No | Number of results per page (default 100) |
createdAfter | string | No | Only return candidates created after this ISO 8601 timestamp (e.g. 2024-01-01T00:00:00Z) |
| Parameter | Type | Description |
|---|
candidates | array | List of candidates |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
Lists all custom field definitions configured in Ashby.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
cursor | string | No | Opaque pagination cursor from a previous response nextCursor value |
perPage | number | No | Number of results per page (default and max 100) |
syncToken | string | No | Opaque token from a prior sync to fetch only items changed since then |
includeArchived | boolean | No | When true, includes archived custom fields in results (default false) |
| Parameter | Type | Description |
|---|
customFields | array | List of custom field definitions |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
syncToken | string | Opaque sync token returned after the last page; pass on next sync |
Lists all departments in Ashby.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
cursor | string | No | Opaque pagination cursor from a previous response nextCursor value |
perPage | number | No | Number of results per page (default and max 100) |
syncToken | string | No | Opaque token from a prior sync to fetch only items changed since then |
includeArchived | boolean | No | When true, includes archived departments in results (default false) |
| Parameter | Type | Description |
|---|
departments | array | List of departments |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
syncToken | string | Opaque sync token returned after the last page; pass on next sync |
Lists interview schedules in Ashby, optionally filtered by application or interview stage.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
applicationId | string | No | The UUID of the application to list interview schedules for |
interviewStageId | string | No | The UUID of the interview stage to list interview schedules for |
cursor | string | No | Opaque pagination cursor from a previous response nextCursor value |
perPage | number | No | Number of results per page (default 100) |
createdAfter | string | No | Only return interview schedules created after this ISO 8601 timestamp (e.g. 2024-01-01T00:00:00Z) |
| Parameter | Type | Description |
|---|
interviewSchedules | array | List of interview schedules |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
Lists all job postings in Ashby.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
location | string | No | Filter by location name (case sensitive) |
department | string | No | Filter by department name (case sensitive) |
listedOnly | boolean | No | When true, only returns listed (publicly visible) job postings (default false) |
jobBoardId | string | No | UUID of a specific job board to filter postings to. If omitted, returns postings on the primary external job board. |
| Parameter | Type | Description |
|---|
jobPostings | array | List of job postings |
Lists all jobs in an Ashby organization. By default returns Open, Closed, and Archived jobs. Specify status to filter.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
cursor | string | No | Opaque pagination cursor from a previous response nextCursor value |
perPage | number | No | Number of results per page (default 100) |
status | string | No | Filter by job status: Open, Closed, Archived, or Draft |
createdAfter | string | No | Only return jobs created after this ISO 8601 timestamp (e.g. 2024-01-01T00:00:00Z) |
openedAfter | string | No | Only return jobs opened after this ISO 8601 timestamp |
openedBefore | string | No | Only return jobs opened before this ISO 8601 timestamp |
closedAfter | string | No | Only return jobs closed after this ISO 8601 timestamp |
closedBefore | string | No | Only return jobs closed before this ISO 8601 timestamp |
| Parameter | Type | Description |
|---|
jobs | array | List of jobs |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
Lists all locations configured in Ashby.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
cursor | string | No | Opaque pagination cursor from a previous response nextCursor value |
perPage | number | No | Number of results per page (default and max 100) |
syncToken | string | No | Opaque token from a prior sync to fetch only items changed since then |
includeArchived | boolean | No | When true, includes archived locations in results (default false) |
includeLocationHierarchy | boolean | No | When true, includes location hierarchy components/regions (default false) |
| Parameter | Type | Description |
|---|
locations | array | List of locations |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
syncToken | string | Opaque sync token returned after the last page; pass on next sync |
Lists all notes on a candidate with pagination support.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
candidateId | string | Yes | The UUID of the candidate to list notes for |
cursor | string | No | Opaque pagination cursor from a previous response nextCursor value |
perPage | number | No | Number of results per page |
| Parameter | Type | Description |
|---|
notes | array | List of notes on the candidate |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
Lists all offers with their latest version in an Ashby organization.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
cursor | string | No | Opaque pagination cursor from a previous response nextCursor value |
perPage | number | No | Number of results per page |
createdAfter | string | No | Only return offers created after this ISO 8601 timestamp (e.g. 2024-01-01T00:00:00Z) |
syncToken | string | No | Opaque token from a prior sync to fetch only items changed since then |
applicationId | string | No | Return only offers for the specified application UUID |
| Parameter | Type | Description |
|---|
offers | array | List of offers |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
Lists all openings in Ashby with pagination.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
cursor | string | No | Opaque pagination cursor from a previous response nextCursor value |
perPage | number | No | Number of results per page (default 100) |
createdAfter | string | No | Only return openings created after this ISO 8601 timestamp (e.g. 2024-01-01T00:00:00Z) |
| Parameter | Type | Description |
|---|
openings | array | Headcount openings associated with the job |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
Lists all candidate sources configured in Ashby.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
includeArchived | boolean | No | When true, includes archived sources in results (default false) |
| Parameter | Type | Description |
|---|
sources | array | List of sources |
Lists all users in Ashby with pagination.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
cursor | string | No | Opaque pagination cursor from a previous response nextCursor value |
perPage | number | No | Number of results per page (default 100) |
includeDeactivated | boolean | No | When true, includes deactivated users in results (default false) |
| Parameter | Type | Description |
|---|
users | array | List of users |
moreDataAvailable | boolean | Whether more pages of results exist |
nextCursor | string | Opaque cursor for fetching the next page |
Removes a tag from a candidate in Ashby and returns the updated candidate.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
candidateId | string | Yes | The UUID of the candidate to remove the tag from |
tagId | string | Yes | The UUID of the tag to remove |
| Parameter | Type | Description |
|---|
id | string | Candidate UUID |
name | string | Full name |
primaryEmailAddress | object | Primary email contact info |
primaryPhoneNumber | object | Primary phone contact info |
emailAddresses | array | All email addresses |
phoneNumbers | array | All phone numbers |
socialLinks | array | Social network links |
linkedInUrl | string | LinkedIn profile URL |
githubUrl | string | GitHub profile URL |
profileUrl | string | URL to the candidate Ashby profile |
position | string | Current position or title |
company | string | Current company |
school | string | Most recent school |
timezone | string | Candidate timezone |
location | object | Candidate location |
tags | array | Tags applied to the candidate |
applicationIds | array | IDs of associated applications |
customFields | array | Custom field values |
resumeFileHandle | object | Resume file reference |
fileHandles | array | All uploaded file references |
source | object | Attribution source |
creditedToUser | object | User credited with sourcing |
fraudStatus | string | Fraud detection status |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last update timestamp |
Searches for candidates by name and/or email with AND logic. Results are limited to 100 matches. Use candidate.list for full pagination.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
name | string | No | Candidate name to search for (combined with email using AND logic) |
email | string | No | Candidate email to search for (combined with name using AND logic) |
| Parameter | Type | Description |
|---|
candidates | array | Matching candidates (max 100 results) |
Updates an existing candidate record in Ashby. Only provided fields are changed.
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Ashby API Key |
candidateId | string | Yes | The UUID of the candidate to update |
name | string | No | Updated full name |
email | string | No | Updated primary email address |
phoneNumber | string | No | Updated primary phone number |
linkedInUrl | string | No | LinkedIn profile URL |
githubUrl | string | No | GitHub profile URL |
websiteUrl | string | No | Personal website URL |
alternateEmail | string | No | An additional email address to add to the candidate |
sourceId | string | No | UUID of the source to attribute the candidate to |
creditedToUserId | string | No | UUID of the Ashby user to credit with sourcing this candidate |
createdAt | string | No | Backdated creation timestamp in ISO 8601. Only updatable if originally backdated. |
sendNotifications | boolean | No | Whether to send a notification when the source is updated (default true) |
socialLinks | json | No | Array of social link objects to set on the candidate, e.g. [{"type":"LinkedIn","url":"https://..."}]. Replaces existing social links. |
| Parameter | Type | Description |
|---|
id | string | Candidate UUID |
name | string | Full name |
primaryEmailAddress | object | Primary email contact info |
primaryPhoneNumber | object | Primary phone contact info |
emailAddresses | array | All email addresses |
phoneNumbers | array | All phone numbers |
socialLinks | array | Social network links |
linkedInUrl | string | LinkedIn profile URL |
githubUrl | string | GitHub profile URL |
profileUrl | string | URL to the candidate Ashby profile |
position | string | Current position or title |
company | string | Current company |
school | string | Most recent school |
timezone | string | Candidate timezone |
location | object | Candidate location |
tags | array | Tags applied to the candidate |
applicationIds | array | IDs of associated applications |
customFields | array | Custom field values |
resumeFileHandle | object | Resume file reference |
fileHandles | array | All uploaded file references |
source | object | Attribution source |
creditedToUser | object | User credited with sourcing |
fraudStatus | string | Fraud detection status |
createdAt | string | ISO 8601 creation timestamp |
updatedAt | string | ISO 8601 last update timestamp |
Trigger workflow when a new application is submitted
| Parameter | Type | Description |
|---|
action | string | The webhook event type (e.g., applicationSubmit, candidateHire) |
application.id | string | Application UUID |
application.createdAt | string | Application creation timestamp (ISO 8601) |
application.updatedAt | string | Application last update timestamp (ISO 8601) |
application.status | string | Application status (Active, Hired, Archived, Lead) |
application.candidate.id | string | Candidate UUID |
application.candidate.name | string | Candidate name |
application.currentInterviewStage.id | string | Current interview stage UUID |
application.currentInterviewStage.title | string | Current interview stage title |
application.currentInterviewStage.stageType | string | Current interview stage type (e.g., Lead, Applied, Interview, Offer) |
application.job.id | string | Job UUID |
application.job.title | string | Job title |
Trigger workflow when a candidate changes interview stages
| Parameter | Type | Description |
|---|
action | string | The webhook event type (e.g., applicationSubmit, candidateHire) |
application.id | string | Application UUID |
application.createdAt | string | Application creation timestamp (ISO 8601) |
application.updatedAt | string | Application last update timestamp (ISO 8601) |
application.status | string | Application status (Active, Hired, Archived, Lead) |
application.candidate.id | string | Candidate UUID |
application.candidate.name | string | Candidate name |
application.currentInterviewStage.id | string | Current interview stage UUID |
application.currentInterviewStage.title | string | Current interview stage title |
application.currentInterviewStage.stageType | string | Current interview stage type (e.g., Lead, Applied, Interview, Offer) |
application.job.id | string | Job UUID |
application.job.title | string | Job title |
Trigger workflow when a candidate is hired
| Parameter | Type | Description |
|---|
action | string | The webhook event type (e.g., applicationSubmit, candidateHire) |
application.id | string | Application UUID |
application.createdAt | string | Application creation timestamp (ISO 8601) |
application.updatedAt | string | Application last update timestamp (ISO 8601) |
application.status | string | Application status (Hired) |
application.candidate.id | string | Candidate UUID |
application.candidate.name | string | Candidate name |
application.currentInterviewStage.id | string | Current interview stage UUID |
application.currentInterviewStage.title | string | Current interview stage title |
application.currentInterviewStage.stageType | string | Current interview stage type (e.g., Lead, Applied, Interview, Offer) |
application.job.id | string | Job UUID |
application.job.title | string | Job title |
offer.id | string | Accepted offer UUID |
offer.applicationId | string | Associated application UUID |
offer.acceptanceStatus | string | Offer acceptance status |
offer.offerStatus | string | Offer process status |
offer.decidedAt | string | Offer decision timestamp (ISO 8601) |
offer.latestVersion.id | string | Latest offer version UUID |
Trigger workflow when a candidate is deleted
| Parameter | Type | Description |
|---|
action | string | The webhook event type (e.g., applicationSubmit, candidateHire) |
candidate.id | string | Deleted candidate UUID |
Trigger workflow when a new job is created
| Parameter | Type | Description |
|---|
action | string | The webhook event type (e.g., applicationSubmit, candidateHire) |
job.id | string | Job UUID |
job.title | string | Job title |
job.confidential | boolean | Whether the job is confidential |
job.status | string | Job status (Open, Closed, Draft, Archived) |
job.employmentType | string | Employment type (FullTime, PartTime, Intern, Contract) |
Trigger workflow when a new offer is created
| Parameter | Type | Description |
|---|
action | string | The webhook event type (e.g., applicationSubmit, candidateHire) |
offer.id | string | Offer UUID |
offer.applicationId | string | Associated application UUID |
offer.acceptanceStatus | string | Offer acceptance status (Accepted, Declined, Pending, Created, Cancelled) |
offer.offerStatus | string | Offer process status (WaitingOnApprovalStart, WaitingOnOfferApproval, WaitingOnApprovalDefinition, WaitingOnCandidateResponse, CandidateRejected, CandidateAccepted, OfferCancelled) |
offer.decidedAt | string | Offer decision timestamp (ISO 8601). Typically null at creation; populated after candidate responds. |
offer.latestVersion.id | string | Latest offer version UUID |
- Category:
tools
- Type:
ashby
