Skip to content

by Startups.Studio

Core grammar Trigger

Trigger.update

PATCH /{namespace}/triggers/{id}

Changes the given properties of a Trigger.

Noun: Trigger
Mode: do
Event: Trigger.updated

You, to your agent

Change the latest trigger.

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

import { $ } from 'startup-builder'

const trigger = await $.Trigger.update({ id: 'trigger_1', threshold: {} })

npx startup-builder do Trigger.update --json '{"id":"trigger_1","threshold":{}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Trigger.update({ id: 'trigger_1', threshold: {} })"
  }
}

Update changes the given properties of a Trigger. It is inherited: every Noun has get, list, create, update and delete.

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`.

Outputs

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

Effects

Emits Trigger.updated.
Two-way: try, send, do.

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.	Trigger.update

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Trigger.list

Previous Page

Verb

Next Page