Workflows
Get a workflow trigger
Read one workflow schedule or other trigger — kind, timing, version pin and next fire time.
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 permissionworkflows:read, held at both the workflow’s home org unit and the trigger’s orgUnitId, as for listTriggers.
Query parameters
Responses
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.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.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.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.Errors
Example
Authorizations
Response
The trigger.

