Ashby Triggers CandidateHiredTrigger

Ashby Triggers CandidateHiredTrigger
Certified
Poll for newly hired applications

Follows application.list incremental sync pages. The first poll seeds the watermark and hired IDs without firing; later updates fire only when an application transitions to Hired.

yaml
type: io.kestra.plugin.ashby.triggers.CandidateHiredTrigger

Examples

React to newly hired applications

yaml
id: ashby_candidate_hired
namespace: company.team
tasks:
  - id: log
    type: io.kestra.plugin.core.log.Log
    message: "{{ trigger.events }}"
triggers:
  - id: ashby
    type: io.kestra.plugin.ashby.triggers.CandidateHiredTrigger
    apiKey: "{{ secret('ASHBY_API_KEY') }}"
    interval: PT15M

Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:

kestractl plugins get io.kestra.plugin:plugin-ashby --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.

Properties

apiKey *string

Ashby API key

Required secret API key used for Basic authentication.

allowConcurrent boolean

Defaultfalse

Specifies whether a trigger is allowed to start a new execution even if a previous run is still in progress.

baseUrl string

Ashby API base URL

Defaults to https://api.ashbyhq.com.

interval string

DefaultPT15M

Formatduration

Polling interval

Defaults to PT15M. The first successful poll seeds the state without firing.

stopAfter array

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

List of execution states after which a trigger should be stopped (a.k.a. disabled).

when string

Defaulttrue

A condition that determines whether the trigger should run.

A Pebble expression evaluated at trigger time. The trigger fires only when the expression evaluates to a truthy value (true, a non-empty string, a non-zero number). Use this to gate trigger execution on dynamic runtime values such as execution labels, flow variables, or environment conditions.

Outputs

events array

SubTypeobject

Matching events

Applications newly transitioned to Hired, or job postings matching the configured publish/unpublish event. One execution contains all matches from the poll.

syncToken string

Incremental sync token

Token from the final application page. Absent for job postings, which use a snapshot instead.