Triggers

Update Trigger

Changed on
patch/api/v1/triggers/{trigger_id}

Request

  • The document declares no server URL.
  • Auth
    • OAuth 2
      Password
      Token URL: api/v1/login
    • or API key in query parameter x-api-key
    • or API key in header x-api-key

Path parameters

trigger_idstring uuid required

Request body

binding_target'flow' | 'deployment'

What a fired event runs.

flow runs the saved flow (or the pinned flow_version when set) through the background execution service. deployment is stored but not dispatched in 1.13 — see :class:BindingUnsupportedError.

concurrency_limitinteger nullable
configobject nullable
connection_idstring uuid nullable
deployment_idstring uuid nullable
flow_version_idstring uuid nullable
max_attemptsinteger nullable
namestring nullable
session_policy'per_event' | 'shared'

How a dispatched run derives its session id when the payload has no conversation.

Response

Successful Response

binding_targetstring required
concurrency_limitinteger required
configobject required
connection_idstring uuid nullable required
created_atstring date-time nullable required
deployment_idstring uuid nullable required
flow_idstring uuid required
flow_version_idstring uuid nullable required
idstring uuid required
kindstring required
last_errorstring nullable required
last_fired_atstring date-time nullable required
max_attemptsinteger required
namestring required
next_fire_atstring date-time nullable required
node_idstring nullable required
providerstring nullable required
session_policystring required
statestring required
updated_atstring date-time nullable required
user_idstring uuid nullable required

Changes