Documentation by ClonePartner

Start typing to search.

API Reference

Get a trigger

View Markdown
GET /api/triggers/{id}

Get a trigger

Operation IDgetTrigger

Authentication

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

Path parameters

idintegerrequired

Resource ID

Success response body

200Trigger details

Trigger details

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

Error responses

404Resource not found

Resource not found

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}