Create Trigger

Add a new trigger to a workflow. The event_type_key must be a valid workflow
trigger event key — an invalid value returns 422. All condition FK fields accept
the integer id or obfuscated public_id of a referenced resource in the same
workspace/team scope.

Condition fields go directly on workflows_trigger
({"workflows_trigger": {"event_type_key": "$optin", "page_id": 123}}). A
trigger field nested in another object, sent beside workflows_trigger, or
given an object or list as its value returns 422 naming the field, and no
trigger is created. A condition left out matches every value, so the response
echoes each condition FK (null when unscoped).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Integer id or obfuscated public_id of the workflow.

Body Params

Parameters for creating a new trigger on a workflow. event_type_key is
required; all condition FK fields accept either the integer id or obfuscated
public_id string for a resource in the same workspace/team scope.

Send every field as a top-level property of workflows_trigger. A trigger
field anywhere else (inside a nested object such as settings, beside
workflows_trigger, or given an object or list as its value) returns 422
naming each misplaced field, and nothing is saved.

An invalid event_type_key returns 422.

workflows_trigger
object
required
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json