Skip to content

Trigger

A Trigger is what starts a Workflow: an Event, a schedule, or a Thing entering a state.

Properties

PropertyTypeRequiredDescription
eventstringThe Event selector it matches, such as Order.placed.
schedulestringA cadence or cron expression.
statestringThe state whose entry fires it.
wherestringThe predicate an event Trigger matches, such as choice = 'raise'.
thresholdjsonA Metric staying below or above a value, optionally for a while, such as four weeks.
atstringWhen in its cadence a schedule runs, on the namespace’s clock, such as mon 09:00.

Object

JSON
{
  "$id": "https://api.sb/tutorloop.com/triggers/trigger_1",
  "$type": "Trigger",
  "event": "Example event",
  "schedule": "Example schedule",
  "state": "Example state",
  "where": "Example where",
  "threshold": {},
  "at": "Example at"
}

Relationships

  • A Trigger fires on many Events: a Trigger fires each time an Event matching its selector happens. firesOn, inverse fires.
  • A Trigger starts many Workflows: when a Trigger fires, each Workflow it starts runs as a new Action. starts, inverse startedBy.

Verbs

  1. createCreates a Trigger.
    POST /{namespace}/triggersdoTrigger.created
  2. getReturns one Trigger by id.
    GET /{namespace}/triggers/{id}readNo Event
  3. listReturns Triggers, newest first, one page at a time.
    GET /{namespace}/triggersreadNo Event
  4. updateChanges the given properties of a Trigger.
    PATCH /{namespace}/triggers/{id}doTrigger.updated
  5. deleteDeletes a Trigger; its history is kept.
    DELETE /{namespace}/triggers/{id}doTrigger.deleted

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Trigger.createYesYesYesNo
Trigger.getYesYesYesYes
Trigger.listYesYesYesYes
Trigger.updateYesYesYesNo
Trigger.deleteYesYesYesNo

Call it

Text
Add a trigger to QuietCopy.

Example

The Event Lead.created is the Trigger of Answer inbound. The schedule 0 9 * * 1 is the Trigger of the Monday Role review.