Workflow Triggers

List of valid attributes:

Attribute	Description	Specifics
account_id	ID of an account a trigger belongs to	Cannot be set
created_at	Timestamp of creation	Cannot be set
event	The action that triggers the workflow	Required. Currently only create is supported
item_type	The type of entity that the event applies to	Required. Currently only user is supported

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.

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