Skip to main content

Trigger reference

A trigger has no input and starts a run by emitting messages; all triggers are always part of the server and emit on the port default.

API_TRIGGER

Emits the payload map the caller gave when starting the run.
  • Options: none.
  • Output port: default.
  • Payload: the start payload, or an empty map.

WEBHOOK_TRIGGER

Starts the run from a signed inbound POST /hooks/{sessionId}/{path}. The call is refused with 401 unless the signature header holds the hex HMAC of the raw body.
  • Output port: default.
  • Payload: {body, headers}.
  • Errors: validation fails when path or secret is missing or blank.

SCHEDULE_TRIGGER

Emits repeatedly on a fixed interval or a cron schedule.
  • Output port: default.
  • Payload: {tick, firedAt}; tick counts from 1 and firedAt is an ISO-8601 instant.
  • Errors: validation fails unless exactly one of cron and intervalMs is set (Exactly one of 'cron' or 'intervalMs' is required), when intervalMs is not positive, or when cron has no future execution.
  • Overrun: an interval tick that arrives while the previous start is still running is dropped and logged, and the schedule continues.

CONSTANT_SOURCE

Emits one message holding predefined variables.
  • Output port: default.
  • Payload: the nested variables when target is PAYLOAD; an empty map when it is METADATA.

SUPERVISOR_SIGNAL

Starts a workflow that decides for a supervisor, with the payload the supervisor started it with. Pair it with SUPERVISOR_DECISION.
  • Output port: default.
  • Errors: validation fails with signals must be a comma-separated list of [...] when a kind is not one of the five.