Skip to navigation
ReferenceTrigger Service

Run a trigger

Runs a route-exposed on-demand trigger directly by its ID.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

triggerIdstringRequired

The trigger’s unique identifier (triggers._id), a UUIDv7.

Request

body
inputsobjectOptional
Exact shape is unconfirmed.
targetTypeenumOptional

One instance or a group. Replaces the Trigger’s stored target type; ignored unless the Trigger is of a resource model.

Allowed values:
targetIdentifierstringOptional

Name of the instance or group. Replaces the Trigger’s stored target identifier; ignored unless the Trigger is of a resource model.

Response

result
executionIdstring
Identifier of the Execution recorded for this fire.
assetIdstringOptional

Id of the asset the fired Trigger targets: the id of the compliance plan for a compliance plan run, of the resource model for a resource model action, of the workflow for a workflow and of the agent definition for an agent.

runobjectOptional

The run the fire started: its type and id. Absent when the target application started none, in which case notStartedReason says why.

jobIdstringOptional
Id of the Workflow Engine Job that stands for the run. Absent when there is no run, and for a run that has no Job of its own.
notStartedReasonstringOptional
Why the target application started no run although it accepted the call. Present only when run is absent.

Errors

500
Internal Server Error