Ashby

All-in-one recruiting ATS with analytics, scheduling, and candidate CRM.

1 trigger12 searches18 actionsInstant (webhooks)Auth: API key

AI-assisted documentation15 min read

This documentation is compiled from our integration source code, internal specs for Ashby, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Ashby on WEXTL →

Requirements

Ashby requires an active account and an API access token from your account settings to connect — both are set up on its own site.[3]

Get your Ashby credentials

API KeytextRequired
Make sure your API key has necessary permissions, at least apiKey.info. See for more.
[1]

Connect Ashby in WEXTL

Log in to your WEXTL account, add the Ashby node module to your workflow, and click Create new credential.
Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Ashby account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Connecting Ashby to WEXTL® — Video slide demonstrates how to integrate Ashby in the WEXTL visual workflow builder.[4]

Video slide demonstrates how to integrate Ashby in the WEXTL visual workflow builder.[4]

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Ashby node modules

The list below is a reference of every Ashby node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Browse every Ashby node module below — each one opens to show its input parameters, outputs, and connection requirements.

Watch EventsTrigger

Output fields[3]

Field	Type
Action	text
Data	object

Get a CandidateAction

Input fields[3]

Field	Type
Retrieve byRequired	choice

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Created At	date
Updated At	date
Name	text
Primary Email Address	object
Email Addresses	array
Primary Phone Number	object
Phone Numbers	array
Social Links	array
Tags	array

Get a JobAction

Input fields[3]

Field	Type
IDRequired	choice
Include Unpublished Job Postings IDs	boolean

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Title	text
Confidential	boolean
Status	text
Employment Type	text
Location ID	text
Department ID	text
Default Interview Plan ID	text
Interview Plan Ids	array
Custom Fields	array

Get a Job PostingAction

Input fields[3]

Field	Type
IDRequired	choice
Include Unpublished Job Postings IDs	boolean

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Title	text
Description Plain	text
Description Html	text
Description Social	text
Description Parts	object
Department Name	text
Team Name	text
Team Name Hierarchy	array
Job ID	text

List Candidate Client InfoSearch

Input fields[3]

Field	Type
Candidate IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
IP Address	text
User Agent	text
Related Entity Type	text
Related Entity ID	text
Candidate ID	text
Created At	date

List Candidate NotesSearch

Input fields[3]

Field	Type
Candidate IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Created At	date
Content	text
Author	object
ID	text
First Name	text
Last Name	text
Email	email

List CandidatesSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Created At	date
Updated At	date
Name	text
Primary Email Address	object
Value	text
Type	text
Is Primary	boolean
Email Addresses	array
Primary Phone Number	object
Value	text
Type	text
Is Primary	boolean
Phone Numbers	array
Social Links	array
Tags	array
Position	text
Company	text
School	text
Application Ids	array
Resume File Handle	object
ID	text
Name	text
Handle	text
File Handles	array
Custom Fields	array
Profile Url	text
Source	object
ID	text
Title	text
Is Archived	boolean
Source Type	object
Credited To User	object
ID	text
First Name	text
Last Name	text
Email	text
Global Role	text
Is Enabled	boolean
Updated At	date

2other output fields

List InterviewsSearch

Input fields[3]

Field	Type
Include Archived	boolean
Include Non-Shared Interviews	boolean
Limit	number

Output fields[3]

Field	Type
ID	text
Title	text
Is Archived	boolean
Is Debrief	boolean
Instructions Html	text
Instructions Plain	text
Job ID	text
Feedback Form Definition ID	text

List Job PostingsSearch

Input fields[3]

Field	Type
Listed Only	boolean
Location	text
Department	text
Job Board ID	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Title	text
Job ID	text
Department Name	text
Team Name	text
Location Name	text
Location Ids	object
Primary Location ID	text
Secondary Location Ids	array
Workplace Type	text
Employment Type	text
Is Listed	boolean
Published Date	text
Application Deadline	date
External Link	text
Apply Link	text
Compensation Tier Summary	text
Should Display Compensation On Job Board	boolean
Updated at	date

List JobsSearch

Input fields[3]

Field	Type
Status	choice
Opened After	date
Opened Before	date
Closed After	date
Closed Before	date
Include Unpublished Job Postings IDs	boolean
Limit	number

Output fields[3]

Field	Type
ID	text
Title	text
Confidential	boolean
Status	text
Employment Type	text
Location ID	text
Department ID	text
Default Interview Plan ID	text
Interview Plan Ids	array
Custom Fields	array
Job Posting Ids	array
Custom Requisition ID	text
Brand ID	text
Hiring Team	array
Author	object
ID	text
First Name	text
Last Name	text
Email	email
Global Role	text
Is Enabled	boolean
Updated at	date
Created at	date
Updated at	date
Opened at	date
Closed at	date
Location	object
ID	text
Name	text
Is Archived	boolean
Address	object
Is Remote	boolean
Workplace Type	text
Parent Location ID	text
Type	text

2other output fields

List OpeningsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Opened At	date
Closed At	date
Is Archived	boolean
Archived At	date
Close Reason ID	text
Opening State	text
Latest Version	object
ID	text
Identifier	text
Description	text
Author ID	text
Created At	date
Team ID	text
Job Ids	array
Target Hire Date	text
Target Start Date	text
Is Backfill	boolean

Search CandidatesSearch

Input fields[3]

Field	Type
Email	email
Name	text
Limit	number

Output fields[3]

Field	Type
ID	text
Created At	date
Updated At	date
Name	text
Primary Email Address	object
Value	text
Type	text
Is Primary	boolean
Email Addresses	array
Primary Phone Number	object
Value	text
Type	text
Is Primary	boolean
Phone Numbers	array
Social Links	array
Tags	array
Position	text
Company	text
School	text
Application Ids	array
Resume File Handle	object
ID	text
Name	text
Handle	text
File Handles	array
Custom Fields	array
Profile Url	text
Source	object
ID	text
Title	text
Is Archived	boolean
Source Type	object
Credited To User	object
ID	text
First Name	text
Last Name	text
Email	text
Global Role	text
Is Enabled	boolean
Updated At	date

2other output fields

Search OpeningsSearch

Input fields[3]

Field	Type
IdentifierRequired	text
Limit	number

Output fields[3]

Field	Type
ID	text
Opened At	date
Closed At	date
Is Archived	boolean
Archived At	date
Close Reason ID	text
Opening State	text
Latest Version	object
ID	text
Identifier	text
Description	text
Author ID	text
Created At	date
Team ID	text
Job Ids	array
Target Hire Date	text
Target Start Date	text
Is Backfill	boolean

Add a Candidate to a ProjectAction

Input fields[3]

Field	Type
Candidate IDRequired	choice
Project IDRequired	choice

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Created At	date
Updated At	date
Name	text
Primary Email Address	object
Email Addresses	array
Primary Phone Number	object
Phone Numbers	array
Social Links	array
Tags	array

Anonymize a CandidateAction

Input fields[3]

Field	Type
Candidate IDRequired	choice

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Created At	date
Updated At	date
Name	text
Primary Email Address	object
Email Addresses	array
Primary Phone Number	object
Phone Numbers	array
Social Links	array
Tags	array

Archive an OpeningAction

Input fields[3]

Field	Type
Opening IDRequired	choice
ArchiveRequired	boolean

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Opened At	date
Closed At	date
Is Archived	boolean
Archived At	date
Close Reason ID	text
Opening State	text
Latest Version	object

Create a CandidateAction

Input fields[3]

Field	Type
NameRequired	text
Email	email
Phone Number	text
LinkedIn URL	url
GitHub URL	url
Website	url
Alternate Email Addresses	array
Email	email
Source ID	choice
Credited To User ID	choice
Location	object
City	text
Region	text
Country	text
Created At	date
Custom Fields	array
Custom Field IDRequired	choice

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Created At	date
Updated At	date
Name	text
Primary Email Address	object
Email Addresses	array
Primary Phone Number	object
Phone Numbers	array
Social Links	array
Tags	array

Create a Candidate NoteAction

Input fields[3]

Field	Type
Candidate IDRequired	choice
NoteRequired	object
TypeRequired	choice
ValueRequired	text
Send Notifications	boolean
Created At	date

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Created At	date
Content	text
Author	object

Create a JobAction

Input fields[3]

Field	Type
TitleRequired	text
Team IDRequired	choice
Location IDRequired	choice
Default Interview Plan ID	choice
Job Template ID	choice
Brand ID	text
Custom Fields	array
Custom Field IDRequired	choice

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Title	text
Confidential	boolean
Status	text
Employment Type	text
Location ID	text
Department ID	text
Default Interview Plan ID	text
Interview Plan Ids	array
Custom Fields	array

Create a Job OpeningAction

Input fields[3]

Field	Type
Job IDsRequired	choice
Target Hire DateRequired	date
Target Start DateRequired	date
Employment TypeRequired	choice
Identifier	text
Description	text
Team ID	text
Location IDs	choice
Is Backfill	boolean
Opening State	choice
Custom Fields	array
Custom Field IDRequired	choice

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Opened At	date
Closed At	date
Is Archived	boolean
Archived At	date
Close Reason ID	text
Opening State	text
Latest Version	object

Make an API Calluniversal

Input fields[3]

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Tag a CandidateAction

Input fields[3]

Field	Type
Candidate IDRequired	choice
Tag IDRequired	choice

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Created At	date
Updated At	date
Name	text
Primary Email Address	object
Email Addresses	array
Primary Phone Number	object
Phone Numbers	array
Social Links	array
Tags	array

Update a CandidateAction

Input fields[3]

Field	Type
Candidate IDRequired	choice
Name	text
Email	email
Phone Number	text
LinkedIn URL	url
GitHub URL	url
Website URL	url
Alternate Email	email
Social Links	array
Location	object
City	text
Region	text
Country	text
Created At	date
Send Notifications	boolean
Source ID	choice
Credited To User ID	choice
Custom Fields	array
Custom Field IDRequired	choice

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Created At	date
Updated At	date
Name	text
Primary Email Address	object
Email Addresses	array
Primary Phone Number	object
Phone Numbers	array
Social Links	array
Tags	array

Update a JobAction

Input fields[3]

Field	Type
Job IDRequired	choice
Title	text
Team ID	choice
Location ID	choice
Default Interview Plan ID	choice
Custom Fields	array
Custom Field IDRequired	choice

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Title	text
Confidential	boolean
Status	text
Employment Type	text
Location ID	text
Department ID	text
Default Interview Plan ID	text
Interview Plan Ids	array
Custom Fields	array

Update a Job PostingAction

Input fields[3]

Field	Type
Job Posting IDRequired	choice
Description	object
TypeRequired	text
ContentRequired	text
Title	text
Workplace Type	choice
Suppress Description Opening	boolean
Suppress Description Closing	boolean

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Title	text
Description Plain	text
Description Html	text
Description Social	text
Description Parts	object
Department Name	text
Team Name	text
Team Name Hierarchy	array
Job ID	text

Update a Job StatusAction

Input fields[3]

Field	Type
Job IDRequired	choice
StatusRequired	choice

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Title	text
Confidential	boolean
Status	text
Employment Type	text
Location ID	text
Department ID	text
Default Interview Plan ID	text
Interview Plan Ids	array
Custom Fields	array

Update an OpeningAction

Input fields[3]

Field	Type
Opening IDRequired	choice
Target Hire Date	date
Target Start Date	date
Employment Type	choice
Identifier	text
Description	text
Team ID	text
Is Backfill	boolean
Custom Fields	array
Custom Field IDRequired	choice

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Opened At	date
Closed At	date
Is Archived	boolean
Archived At	date
Close Reason ID	text
Opening State	text
Latest Version	object

Update an Opening StateAction

Input fields[3]

Field	Type
Opening IDRequired	choice
Opening StateRequired	choice
Close Reason ID	choice

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Opened At	date
Closed At	date
Is Archived	boolean
Archived At	date
Close Reason ID	text
Opening State	text
Latest Version	object

Update Job CompensationAction

Input fields[3]

Field	Type
Job IDRequired	choice
Compensation TiersRequired	array

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Title	text
Confidential	boolean
Status	text
Employment Type	text
Location ID	text
Department ID	text
Default Interview Plan ID	text
Interview Plan Ids	array
Custom Fields	array

Upload a Candidate ResumeAction

Input fields[3]

Field	Type
Candidate IDRequired	choice
Resume FileRequired	text

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Created At	date
Updated At	date
Name	text
Primary Email Address	object
Email Addresses	array
Primary Phone Number	object
Phone Numbers	array
Social Links	array
Tags	array

Upload a File to a CandidateAction

Input fields[3]

Field	Type
Candidate IDRequired	choice
FileRequired	text

Output fields[3]

Field	Type
Success	boolean
Results	object
ID	text
Created At	date
Updated At	date
Name	text
Primary Email Address	object
Email Addresses	array
Primary Phone Number	object
Phone Numbers	array
Social Links	array
Tags	array

Templates

Look for Ashby templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in HR category →

References

WEXTL® Ashby Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Ashby.
WEXTL® visual workflow builder data.

Last updated: Jul 23, 2026 22:38

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.