Deel Invoices InvoiceIssuedTrigger

Deel Invoices InvoiceIssuedTrigger
Certified
Invoice Issued Trigger

Poll GET /rest/invoices with status=all and trigger on newly issued invoices. State (watermark and already-seen invoice ids) is persisted in the KV store so polls do not repeat events. Invoices without any timestamp are emitted exactly once via the seen-ids set.

yaml
type: io.kestra.plugin.deel.invoices.InvoiceIssuedTrigger

Examples

Trigger on newly issued invoices

yaml
id: invoice_events
namespace: company.team
tasks:
  - id: log
    type: io.kestra.plugin.core.log.Log
    message: "New invoice {{ trigger.invoice.label }} ({{ trigger.invoice.total }} {{ trigger.invoice.currency }})"
triggers:
  - id: watch_invoices
    type: io.kestra.plugin.deel.invoices.InvoiceIssuedTrigger
    apiToken: "{{ secret('DEEL_API_TOKEN') }}"
    interval: PT5M

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

apiToken *string

Deel API token

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

allowConcurrent boolean

Defaultfalse

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

apiVersion string

Default2026-01-01

API version

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

baseUrl string

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.

interval string

DefaultPT5M

Formatduration

Polling interval

How often the Deel API is polled for new events.

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

Events

All detected events in this poll.

invoice object

Invoice

The newly issued invoice.