Workflow Triggers

List of valid attributes:

Attribute	Description	Specifics
created_at	Timestamp of creation	Cannot be set
discarded_at	Null or timestamp of removal	Cannot be set
trigger_id	The ID of the specific trigger that this trigger refers to	Cannot be set
trigger_type	The specific type of trigger that this trigger refers to	Cannot be set
updated_at	Timestamp of the latest update	Cannot be set
workflow_id	The ID of the workflow that this trigger belongs to	Cannot be set

The following relationships can be included in requests:

Relationship	Type	Description
trigger	belongs to	the specific type of trigger, e.g. a workflow_event_trigger

Create

Example request:

{
  "data": {
    "type": "workflow_event_trigger",
    "attributes": {
      "event": "create",
      "item_type": "user"
    }
  }
}

Example response:

{
  "data": {
    "id": "85579c3b-22ea-43b8-ab79-d60d05680be5",
    "type": "workflow_event_trigger",
    "attributes": {
      ...
    }
  }
}

This endpoint creates a new trigger for a workflow.

⚠️ Attention: The data in the body should not be a workflow_trigger, but a specific type of trigger instead - e.g. a workflow_event_trigger.

HTTP Request

POST /api/v1/workflows/:workflow_id/trigger

URL Parameters

Parameter	Description
workflow_id	The ID of the workflow that the trigger belongs to