Skip to main content
A trigger gives an agent a public URL. Whoever calls it starts a run. See Webhook triggers for the HTTP contract on the other side of that URL.

​
list_triggers

Lists an agent triggers in full: slug, name, body, accepted methods, enabled, fireCount, lastFiredAt, and url, the public webhook address to paste into the other service.
​
string
required
Every URL returned here carries the trigger secret. Treat each one as a credential, and do not log the response.

​
upsert_trigger

Creates a trigger, or updates it when slug is given.
​
string
required
​
string
Omit to create. Pass an existing slug to update.
​
string
Required when creating. The slug, and therefore the public URL, is derived from it.
​
string
Required when creating. The instruction sent to the agent when the URL is called.
​
string[]
Accepted HTTP methods among GET, POST, PUT, PATCH, DELETE. Defaults to ["POST"].
​
string
​
boolean
The caller HTTP payload is appended to body automatically inside a <trigger_payload> block. Write the instruction as “a Stripe refund event arrives, do X with it”, not as if the payload had to be fetched. The response carries the full url, which is a secret: anyone holding it can fire the agent.
A trigger cannot be renamed, because the public URL is built from the slug. Delete and recreate, knowing the URL changes and every caller has to be updated.
Adding GET to methods means any link preview or prefetch of that URL could fire the agent. Rerun filters known previewers, but POST alone is the safer default.

​
test_trigger

Fires a trigger yourself with a sample payload, to check the instruction before handing the URL to another service.
​
string
required
​
string
required
​
string | object
The payload. An object is sent as JSON. Defaults to empty. Maximum 1 MB, the same cap the public URL enforces.
​
string
One of GET, POST, PUT, PATCH, DELETE. Defaults to the first method the trigger accepts.
​
string
Query string to simulate, without the leading ?.
​
string
Defaults to application/json when the body is JSON.
This is a real fire, not a dry run. It counts towards the trigger fire count and updates its last-fired date. It also needs the trigger to be enabled: unlike run_schedule_now, firing a disabled trigger fails, because the engine answers a disabled trigger exactly like a missing one.
Returns runId and sessionId. Read the outcome with get_run.

​
rotate_trigger_token

Issues a new secret for a trigger and returns its new URL.
​
string
required
​
string
required
The previous URL stops working immediately, so every service already configured with it has to be updated. Use this when a URL has leaked.

​
delete_trigger

Deletes a trigger. Its URL stops working at once and any service calling it starts failing.
​
string
required
​
string
required
​
boolean
required
Must be true.