Deel People PersonTrigger

Deel People PersonTrigger

Certified

Person Trigger

Poll the People endpoint and trigger on created people and hiring status changes. State (watermark and last-seen hiring statuses) is persisted in the KV store so polls do not repeat events. The Deel API does not return the previous hiring status; it is tracked client-side from earlier polls.

yaml
type: io.kestra.plugin.deel.people.PersonTrigger

Trigger on new people and hiring status changes

yaml
id: person_events
namespace: company.team
tasks:
  - id: log
    type: io.kestra.plugin.core.log.Log
    message: "{{ trigger.event }}: {{ trigger.person.full_name }} ({{ trigger.person.hiring_status }})"
triggers:
  - id: watch_people
    type: io.kestra.plugin.deel.people.PersonTrigger
    apiToken: "{{ secret('DEEL_API_TOKEN') }}"
    interval: PT5M
    events:
      - created
      - hiring_status_changed
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-deel --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

Deel API token

API token for authentication. Can be an organization token, personal token, or worker token.

Defaultfalse

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

Default2026-01-01

API version

API version header value. Defaults to 2026-01-01.

Defaulthttps://api.letsdeel.com/rest

Deel API base URL

Base URL for the Deel API. Use https://api-sandbox.demo.deel.com/rest for sandbox environment.

SubTypestring
Default["created","hiring_status_changed"]
Possible Values
createdhiring_status_changed

Events to trigger on

Which person events create executions.

DefaultPT5M
Formatduration

Polling interval

How often the Deel API is polled for new events.

SubTypestring
Possible Values
CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

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

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.

Event type

The detected event: created or hiring_status_changed.

SubTypeobject

Events

All detected events in this poll.

Person

The person that caused the first event.

Previous hiring status

Hiring status observed on the previous poll. Only set for hiring_status_changed events; the Deel API does not provide it, it is tracked from earlier polls.