ContextQMD
Back to Airbyte

Ashby

docs/integrations/sources/ashby.md

2.0.08.5 KB
Original Source

Ashby

<HideInUI>

This page contains the setup guide and reference information for the Ashby source connector.

</HideInUI>

Prerequisites

  • An Ashby account
  • An Ashby API key with the appropriate permissions for the streams you want to sync. See the Ashby authentication docs for details on how to create an API key.

Your API key must have read permissions enabled for the modules that correspond to the streams you want to sync:

Ashby permission moduleStreams
Candidatesapplications, application_criteria_evaluations, candidates
Interviewsinterviews, interview_stages, interview_schedules
Jobsjobs, job_postings
Hiring Processarchive_reasons, candidate_tags, custom_fields, feedback_form_definitions, sources
Organizationdepartments, locations, users
Offersoffers

:::note The application_criteria_evaluations stream requires the AI Application Review feature to be enabled for your Ashby organization. If this feature is not enabled, the stream returns empty results. :::

Setup guide

  1. Log in to your Ashby account.
  2. Generate an API key following the Ashby authentication guide. Grant the API key read permissions for the modules listed in the prerequisites.
  3. In Airbyte, create a new Ashby source.
  4. Enter your API key.
  5. Enter a Start date in YYYY-MM-DDTHH:MM:SSZ format. The connector only replicates data created on or after this date for the applications and interview_schedules streams.

Supported sync modes

FeatureSupported
Full RefreshYes
Incremental - AppendNo

Supported streams

This source syncs the following streams:

The application_criteria_evaluations stream fetches AI-generated criteria evaluations for applications that are in the Application Review interview stage and have an active status. It uses the applicationId from the parent applications stream.

Performance considerations

The Ashby connector should not run into Ashby API limitations under normal usage.

Changelog

<details> <summary>Expand to review</summary>
VersionDatePull RequestSubject
0.3.32026-03-1074490Update dependencies
0.3.22026-02-2473805Update dependencies
0.3.12026-02-1760692Update dependencies
0.3.02026-02-1373244Add interviews, interview_stages, and application_criteria_evaluations streams
0.2.232025-05-1059853Update dependencies
0.2.222025-05-0359322Update dependencies
0.2.212025-04-2658746Update dependencies
0.2.202025-04-1958271Update dependencies
0.2.192025-04-1257150Update dependencies
0.2.182025-03-2956594Update dependencies
0.2.172025-03-2256140Update dependencies
0.2.162025-03-0855387Update dependencies
0.2.152025-03-0154888Update dependencies
0.2.142025-02-2254234Update dependencies
0.2.132025-02-1553874Update dependencies
0.2.122025-02-0853407Update dependencies
0.2.112025-02-0152893Update dependencies
0.2.102025-01-2552162Update dependencies
0.2.92025-01-1851710Update dependencies
0.2.82025-01-1151292Update dependencies
0.2.72024-12-2850493Update dependencies
0.2.62024-12-2150207Update dependencies
0.2.52024-12-1449572Update dependencies
0.2.42024-12-1249014Update dependencies
0.2.32024-11-0448196Update dependencies
0.2.22024-10-2947729Update dependencies
0.2.12024-10-2847616Update dependencies
0.2.02024-08-1944420Refactor connector to manifest-only format
0.1.162024-08-1744288Update dependencies
0.1.152024-08-1243780Update dependencies
0.1.142024-08-1043491Update dependencies
0.1.132024-08-0343080Update dependencies
0.1.122024-07-2742658Update dependencies
0.1.112024-07-2042220Update dependencies
0.1.102024-07-1742028Fix typo in application stream
0.1.92024-07-1341818Update dependencies
0.1.82024-07-1041379Update dependencies
0.1.72024-07-0941271Update dependencies
0.1.62024-07-0640971Update dependencies
0.1.52024-06-2540469Update dependencies
0.1.42024-06-2240107Update dependencies
0.1.32024-06-0639159[autopull] Upgrade base image to v1.2.2
0.1.22024-05-2838666Make connector compatible with Builder
0.1.12024-05-2038421[autopull] base image + poetry + up_to_date
0.1.02022-10-2218334Add Ashby Source Connector
</details>