Triggers

Set up

TypeScript

npm install @reminix/sdk

import { createClient } from "@reminix/sdk";

const reminix = createClient(); // reads REMINIX_API_KEY

Python

pip install reminix

from reminix import Reminix

reminix = Reminix()  # reads REMINIX_API_KEY

CLI

npm install -g @reminix/cli
reminix login

curl

export REMINIX_API_KEY="<your API key>"

List a script’s triggers

GET /v1/scripts/{slug}/triggers

The events that start it.

TypeScript

await reminix.triggers.list("alert-on-failure");

Python

reminix.triggers.list("alert-on-failure")

CLI

reminix triggers list alert-on-failure

curl

curl -X GET "https://api.reminix.com/v1/scripts/alert-on-failure/triggers" \
  -H "Authorization: Bearer $REMINIX_API_KEY"

Field	Description
slugstring, path, required

Run a script on an event

POST /v1/scripts/{slug}/triggers

Starts a run, as you, when an event of eventType happens in the workspace (GET /v1/workspace/event-types lists them) and its data matches filter — within about a minute.

TypeScript

await reminix.triggers.create("alert-on-failure", {
  name: "Nightly sync failed",
  eventType: "run.failed",
});

Python

reminix.triggers.create(
    "alert-on-failure",
    name="Nightly sync failed",
    event_type="run.failed",
)

CLI

reminix triggers create \
  alert-on-failure \
  --name 'Nightly sync failed' \
  --event-type run.failed

curl

curl -X POST "https://api.reminix.com/v1/scripts/alert-on-failure/triggers" \
  -H "Authorization: Bearer $REMINIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Nightly sync failed","eventType":"run.failed"}'

Field	Description
slugstring, path, required
namestring, required	A name for the trigger, shown in the app.
eventTypestring, required	The event that starts a run: any webhook event type, such as run.failed.
filterobject	Event data fields (dotted paths) that must equal these values.
inputsobject	The script's inputs for each run, by name; a value "{{event.data.<path>}}" takes it from the event.
environmentstring	The environment its runs use. Default: the request's (X-Environment), else the workspace's default.

More about this endpoint

A chain of triggered runs stops after 3.

Change a trigger

PATCH /v1/scripts/{slug}/triggers/{triggerId}

Its name, filter, inputs, or switch it on or off.

TypeScript

await reminix.triggers.update("alert-on-failure", "<trigger-id>");

Python

reminix.triggers.update("alert-on-failure", "<trigger-id>")

CLI

reminix triggers update alert-on-failure '<trigger-id>'

curl

curl -X PATCH "https://api.reminix.com/v1/scripts/alert-on-failure/triggers/<trigger-id>" \
  -H "Authorization: Bearer $REMINIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Field	Description
slugstring, path, required
triggerIdstring, path, required
namestring	A name for the trigger, shown in the app.
filterobject	Event data fields (dotted paths) that must equal these values.
inputsobject	The script's inputs for each run, by name; a value "{{event.data.<path>}}" takes it from the event.
enabledboolean	Whether it fires. Default: true.
environmentstring	Move its runs to another environment.

More about this endpoint

Its creator, or an owner or admin.

Delete a trigger

DELETE /v1/scripts/{slug}/triggers/{triggerId}

Its creator, or an owner or admin.

TypeScript

await reminix.triggers.delete("alert-on-failure", "<trigger-id>");

Python

reminix.triggers.delete("alert-on-failure", "<trigger-id>")

CLI

reminix triggers delete alert-on-failure '<trigger-id>' --yes

curl

curl -X DELETE "https://api.reminix.com/v1/scripts/alert-on-failure/triggers/<trigger-id>" \
  -H "Authorization: Bearer $REMINIX_API_KEY"

Field	Description
slugstring, path, required
triggerIdstring, path, required