Trigger routes: update, delete

Reference for Trigger, one group of Trigger routes.

Trigger.update

Changes the given properties of a Trigger. Verb page.

Text

PATCH /{namespace}/triggers/{id}

Path: id. Body, as JSON: the other inputs. Emits Trigger.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Trigger.
`event`	`string`		The Event selector it matches, such as `Order.placed`.
`schedule`	`string`		A cadence or cron expression.
`where`	`string`		The predicate an `event` Trigger matches, such as `choice = 'raise'`.
`threshold`	`json`		A Metric staying below or above a value, optionally for a while, such as four weeks.
`at`	`string`		When in its cadence a schedule runs, on the namespace’s clock, such as `mon 09:00`.

Returns

Output	Type	Required	Description
`trigger`	Trigger	required	The Trigger.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

curl -X PATCH https://api.sb/leaseline.app/triggers/trigger_Hg9n0lrBdP \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"threshold":{}}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "trigger": {
    "$id": "https://api.sb/leaseline.app/triggers/trigger_Hg9n0lrBdP",
    "$type": "Trigger",
    "event": "Example event",
    "schedule": "Example schedule",
    "threshold": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Trigger.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Trigger.delete

Deletes a Trigger: a soft delete that keeps its history, undone by Thing.restore. Verb page.