Triggers

Operations of the Workflow Engine API. Paths are relative to your deployment's API host.

GET /api/workflow-engine-api/triggers

List webhook triggers visible to the caller org.

Returns (a) every org-scoped row belonging to the caller, plus (b) every shared row from a system workflow UNLESS the caller has forked it to an org_override — the override is returned instead. Paged newest-first.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
eventquerystringno
limitquerynumberno
offsetquerynumberno
workflowSlugquerystringno
StatusDescriptionBody
200application/json TriggerResponseDtoDataArrayEnvelope

GET /api/workflow-engine-api/triggers/{id}

Get a trigger by id (org-scoped OR shared).

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json TriggerResponseDtoDataEnvelope

POST /api/workflow-engine-api/triggers/{id}/delegation

Authorize this org's trigger deliveries under your organization's authority.

A trigger whose workflow hands organization authority to another workload, or reads a wallet, runs with no member present — so a member records an organization delegation from their own context, lending exactly delegation.capabilities. Held by the engine, renewed, revoked when the trigger goes away. A shared trigger belongs to no organization and is refused: authorize your organization's override (any pause/resume/filters call creates it).

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json TriggerResponseDtoDataEnvelope

PATCH /api/workflow-engine-api/triggers/{id}/filters

Update the filters map.

Replaces the row's filters column. For a shared trigger, forks to an org_override carrying the new filters so the caller's org can narrow the subscription without affecting other orgs. For org / org_override rows, updates in place.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes

Request body: application/json UpdateTriggerFiltersDto

StatusDescriptionBody
200application/json TriggerResponseDtoDataEnvelope

POST /api/workflow-engine-api/triggers/{id}/pause

Pause dispatching for this org (stops until resumed).

For an org or org_override trigger: sets state=paused in place. For a shared trigger: forks the row into a new org_override with state=paused, leaving the shared row untouched for every other org. Pause/resume never affects other orgs.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json TriggerResponseDtoDataEnvelope

POST /api/workflow-engine-api/triggers/{id}/resume

Resume a paused trigger for this org.

For an org or org_override trigger: flips state to active in place. For a shared trigger: creates an org_override with state=active — usually a no-op (shared rows default to active) but models the intent so subsequent operator actions have somewhere to land.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json TriggerResponseDtoDataEnvelope