Provider guides
Ashby
What’s supported
Supported actions
This connector supports:- Read Actions, including full historic backfill. Please note that incremental read is supported only for
application,applicationFeedbackandinterviewSchedulecurrently. For all other objects, a full read of the Ashby instance will be done per scheduled read. - Write Actions.
- Proxy Actions, using the base URL
https://api.ashbyhq.com.
Supported Objects
The Ashby connector supports writing to and reading from the following objects:- application (read, write),
- applicationFeedback (read),
- applicationHiringTeamRole (read)
- archiveReason (read)
- assessment (read),
- candidate (read, write),
- candidateTag (read, write),
- communicationTemplate (read)
- customField (read, write),
- department (read, write),
- feedbackFormDefinition (read)
- interview (read)
- interviewPlan (read)
- interviewSchedule (read, write),
- interviewStageGroup (read)
- interviewerPool (read, write),
- job (read, write),
- jobBoard (read)
- jobPosting (read),
- jobTemplate (read)
- location (read, write),
- offer (read, write),
- opening (read, write),
- project (read)
- referral (write)
- source (read)
- sourceTrackingLink (read)
- surveyFormDefinition (read)
- surveyRequest (write)
- surveySubmission (write)
- user (read)
- webhook [write]
Using the connector
This connector uses Basic Auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.) To start integrating with Ashby:- Create a manifest file like the example.
- Deploy it using the amp CLI.
- If you are using Read Actions, create a destination.
- Embed the InstallIntegration UI component. The UI component will prompt the customer for their username and password.
- Start using the connector!
- If your integration has Read Actions, you’ll start getting webhook messages.
- If your integration has Write Actions, you can start making API calls to our Write API.
- If your integration has Proxy Actions, you can start making Proxy API calls.