API Reference

Create a trigger

View Markdown

POST /api/triggers

Create a trigger

Operation IDcreateTrigger

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Request body

This request body is required.

Content typeapplication/json

requestobject

6 properties

job_idintegerrequired

task_keystring

Specific task key within the job to trigger

typestring

Default: cron
Allowed values: cron, one_off

cron_expressionstring

Cron expression (e.g. '0 */6 * * *') for type=cron; ISO-8601 datetime (UTC) in the future for type=one_off.

argumentsobject

Additional properties are allowed.

enabledboolean

Default: true

Success response body

201Trigger created

Trigger created

Content typeapplication/json

responseobject

10 properties

idinteger

job_idinteger

task_keystring | null

Nullable: yes

typestring

cron repeats on a cron expression; one_off fires once at the datetime in cron_expression then auto-disables.

Allowed values: cron, one_off

cron_expressionstring | null

5-field cron expression for type=cron; ISO-8601 datetime (UTC) for type=one_off.

Nullable: yes

argumentsstring | null

JSON-encoded arguments

Nullable: yes

enabledinteger

Allowed values: 0, 1

last_triggered_atstring | null · date-time

Nullable: yes

created_atstring · date-time

updated_atstring · date-time

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/triggers' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "job_id": 0
}'

const response = await fetch("https://your-envoy.example.com/api/triggers", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "job_id": 0
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);