Skip to main content
GET
Get one workflow trigger
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/workflows/getTrigger?id=<triggerId> Returns one schedule or other trigger of a workflow. To change a trigger, use updateTrigger, updateIngressConfig and the other trigger writes.

Authentication

External App credential or platform API key. Requires permission workflows:read, held at both the workflow’s home org unit and the trigger’s orgUnitId, as for listTriggers.

Query parameters

string
required
The trigger ID, from listTriggers.

Responses

string
The trigger ID.
string
The workflow the trigger starts.
"cron" | "one_shot" | "ingress" | "email"
cron fires on a schedule, one_shot fires once at oneShotFireAt, ingress fires when its capability URL receives a POST, and email fires on a routed inbound email.
string | null
The published version every fire runs. null means the trigger follows the active version: each fire runs the version that is active when the scheduler claims it.
string
The org unit the trigger’s fires run at. Their runs are recorded and read there.
boolean
Whether the trigger fires. For an ingress trigger, whether its URL is active; for an email trigger, whether its email route is enabled. Always false while the workflow is paused or retired, because no run of it can start.
string | null
The schedule of a cron trigger.
string | null
The IANA time zone the schedule is read in.
number | null
When a one_shot trigger fires, in epoch milliseconds.
"coalesce" | "fire_each_missed" | "drop"
What the scheduler does with fires it missed.
number | null
When the trigger next fires, in epoch milliseconds. null when it is not scheduled to fire: an ingress or email trigger, a disabled one, or one whose workflow is paused or retired.
number | null
When the trigger last fired, in epoch milliseconds.
number
How many scheduled fires in a row were missed.
boolean
Whether the trigger stores run inputs for its fires. The inputs themselves are not returned.
number
When the trigger was created, in epoch milliseconds.
number | null
When the trigger was last changed, in epoch milliseconds.
The response never includes the trigger’s owner or creator, its stored inputs, its ingress token, verification secret or delivery settings, its email route, or its governance keys. Those stay in the Console.

Errors

Example

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

triggerId
string
required

Trigger id from listTriggers.

Minimum string length: 1

Response

The trigger.

data
object
required

One schedule or other trigger of a workflow. No owner, creator, stored input, ingress token or verification material is returned. Change one with POST /api/v2/workflows/createTrigger, updateTrigger, pauseTrigger, resumeTrigger, deleteTrigger and the ingress operations.

meta
object
required