You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/content/docs/integrations/ashby.mdx
+31-15Lines changed: 31 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -249,7 +249,7 @@ Moves an application to a different interview stage. Requires an archive reason
249
249
|`applicationId`| string | Yes | The UUID of the application to update the stage of |
250
250
|`interviewStageId`| string | Yes | The UUID of the interview stage to move the application to |
251
251
|`archiveReasonId`| string | No | Archive reason UUID. Required when moving to an Archived stage, ignored otherwise |
252
-
|`archiveEmail`|boolean| No |Send Ashby archive email automation when archiving|
252
+
|`archiveEmail`|json| No |Archive email configuration with communicationTemplateId and optional sendAt ISO 8601 timestamp. Pass null or omit to send no archive email.|
253
253
254
254
#### Output
255
255
@@ -306,7 +306,7 @@ Creates a new application for a candidate on a job. Optionally specify interview
306
306
|`candidateId`| string | Yes | The UUID of the candidate to consider for the job |
307
307
|`jobId`| string | Yes | The UUID of the job to consider the candidate for |
308
308
|`interviewPlanId`| string | No | UUID of the interview plan to use \(defaults to the job default plan\)|
309
-
|`interviewStageId`| string | No | UUID of the interview stage to place the application in\(defaults to first Lead stage\)|
309
+
|`interviewStageId`| string | No | UUID of the interview stage to place the application in, or FirstPreInterviewScreen \(defaults to the first Lead stage\)|
310
310
|`sourceId`| string | No | UUID of the source to set on the application |
311
311
|`creditedToUserId`| string | No | UUID of the user the application is credited to |
312
312
|`createdAt`| string | No | ISO 8601 timestamp to set as the application creation date \(defaults to now\)|
@@ -882,7 +882,7 @@ Lists all applications in an Ashby organization with pagination and optional fil
882
882
|`apiKey`| string | Yes | Ashby API Key |
883
883
|`cursor`| string | No | Opaque pagination cursor from a previous response nextCursor value |
884
884
|`perPage`| number | No | Number of results per page \(default 100\)|
885
-
|`status`|json| No |One application status or an array of statuses to include: Active, Hired, Archived, or Lead |
885
+
|`status`|string| No |Application status to include: Active, Hired, Archived, or Lead |
886
886
|`jobId`| string | No | Filter applications by a specific job UUID |
887
887
|`createdAfter`| string | No | Filter to applications created after this ISO 8601 timestamp \(e.g. 2024-01-01T00:00:00Z\)|
888
888
|`createdBefore`| string | No | Filter to applications created before this ISO 8601 timestamp |
@@ -1128,7 +1128,6 @@ Lists the ordered stages in an Ashby interview plan.
1128
1128
| ↳ `interviewPlanId`| string | Parent plan UUID |
1129
1129
| ↳ `orderInInterviewPlan`| number | Zero-based plan order |
1130
1130
| ↳ `interviewStageGroupId`| string | Stage group UUID |
1131
-
|`moreDataAvailable`| boolean | Whether more data is available |
1132
1131
1133
1132
### Ashby List Job Postings
1134
1133
@@ -1617,21 +1616,21 @@ Updates an existing candidate record in Ashby. Only provided fields are changed.
1617
1616
|`apiKey`| string | Yes | Ashby API Key |
1618
1617
|`onBehalfOfUserId`| string | No | Active Ashby user UUID to attribute this mutation to; the API key must permit on-behalf-of calls |
1619
1618
|`candidateId`| string | Yes | The UUID of the candidate to update |
1620
-
|`name`| string | No | Updated full name |
1621
-
|`email`| string | No | Updated primary email address |
1622
-
|`phoneNumber`| string | No | Updated primary phone number |
1623
-
|`linkedInUrl`| string | No | LinkedIn profile URL |
1624
-
|`githubUrl`| string | No | GitHub profile URL |
1625
-
|`websiteUrl`| string | No | Personal website URL |
1626
-
|`alternateEmail`| string | No | An additional email address to add to the candidate |
1619
+
|`name`| string | No | Updated full name, or null|
1620
+
|`email`| string | No | Updated primary email address, or null|
1621
+
|`phoneNumber`| string | No | Updated primary phone number, or null|
1622
+
|`linkedInUrl`| string | No | LinkedIn profile URL, or null|
1623
+
|`githubUrl`| string | No | GitHub profile URL, or null|
1624
+
|`websiteUrl`| string | No | Personal website URL, or null|
1625
+
|`alternateEmail`| string | No | An additional email address to add to the candidate, or null|
1627
1626
|`sourceId`| string | No | UUID of the source to attribute the candidate to |
1628
1627
|`creditedToUserId`| string | No | UUID of the Ashby user to credit with sourcing this candidate |
1629
1628
|`clearSource`| boolean | No | Explicitly clear the candidate source; mutually exclusive with sourceId |
1630
1629
|`clearCreditedToUser`| boolean | No | Explicitly clear the credited Ashby user; mutually exclusive with creditedToUserId |
1631
-
|`location`| json | No | Candidate location object with optional city, region, and country; pass null fields to clear parts|
1632
-
|`createdAt`| string | No | Backdated creation timestamp in ISO 8601. Only updatable if originally backdated. |
1633
-
|`sendNotifications`| boolean | No | Whether to send a notification when the source is updated \(default true\)|
1634
-
|`socialLinks`| json | No | Array of social link objects to set on the candidate, e.g. \[\{"type":"LinkedIn","url":"https://..."\}\]. Replaces existing social links. |
1630
+
|`location`| json | No | Candidate location object with optional city, region, and country; the object and its fields accept null|
1631
+
|`createdAt`| string | No | Backdated creation timestamp in ISO 8601, or null. Only updatable if originally backdated. |
1632
+
|`sendNotifications`| boolean | No | Whether to send a notification when the source is updated \(default true\), or null|
1633
+
|`socialLinks`| json | No | Array of social link objects to set on the candidate, e.g. \[\{"type":"LinkedIn","url":"https://..."\}\]. Replaces existing links; pass \[\] to clear them. Null is also accepted. Mutually exclusive with linkedInUrl, githubUrl, and websiteUrl. |
1635
1634
1636
1635
#### Output
1637
1636
@@ -1866,6 +1865,7 @@ Trigger workflow when a new application is submitted
1866
1865
| Parameter | Type | Description |
1867
1866
| --------- | ---- | ----------- |
1868
1867
|`action`| string | The webhook event type \(e.g., applicationSubmit, candidateHire\)|
1868
+
|`webhookActionId`| string | Ashby delivery identifier, stable across retries |
1869
1869
|`application`| object | application output from the tool |
0 commit comments