Workflows

Endpoints for managing Workflows.

List Workflows
List Workflow Rules

List Workflows

This endpoint allows you to list workflows that you have access to edit.

GET

/v1/workflows

Parameters

Name	Type	Description
`before`	string	A pagination cursor for entries before a specific point in the collection.
`after`	string	A pagination cursor for entries after a specific point in the collection.
`limit`	integer	The maximum number of entries to retrieve (defaults to 20, up to 100 allowed).

Response

200

When successful, returns a Paginated List of Workflow resources.

{
  "entries": [
    // items
  ],
  "metadata": {
    "before": null,
    "after": "g3QAAAABZAACaWRiAAAbFA==",
    "limit": 20
  }
}

List Workflow Rules

This endpoint allows you to list rules for a workflow.

GET

/v1/workflows/:workflow_id/rules

Parameters

None.

Response

200

When successful, returns a list of Workflow Rule resources.

[
  {
    "id": "wrule_01ED74HMFGVZ92YVCWTD8Y8H6X",
    "trigger_type": "event_started",
    "trigger_offset_amount": 10,
    "trigger_offset_unit": "minutes",
    "trigger_offset_direction": "before",
    "created_at": "2021-01-01T10:00:00Z",
    "actions": [{
      "id": "waction_01ED74HMFGVZ92YVCWTD8Y8H6X",
      "type": "trigger_automation",
      "properties": {
        "provider": "zapier",
        "description": "Post in Slack"
      },
      "created_at": "2021-01-01T10:00:00Z"
    }]
  }
]