Retrieve Workflow Trigger Definitions

Retrieve every event a workflow can be started by, each with the filters that narrow it down and the options it can be configured with.

Use this before creating or updating a workflow: a trigger's name is what goes into a trigger's name, and the keys of its filters are the attribute values its filters can use.

A trigger's output decides what the workflow's first steps are handed, and therefore the workflow's workflow_type. All triggers on one workflow must produce the same entity_type.

The list is the same for every account — it describes what the platform supports, not what the account has set up. Triggers are added over time, so treat the list as open-ended and ignore any trigger you do not recognise.

Credit Note: Retrieving trigger definitions does not consume credits.

INFO

Requires the workflows:read OAuth2 scope.

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "data": [
        {
            "type": "workflow_trigger_definition",
            "id": "company_added_to_list",
            "attributes": {
                "name": "company_added_to_list",
                "output": {
                    "entity_type": "company"
                },
                "filters": {
                    "list_id": {
                        "entity_type": "company_list",
                        "required": true,
                        "array": false,
                        "available_options": null
                    }
                },
                "options": {
                    "type": {
                        "entity_type": "string",
                        "required": false,
                        "array": false,
                        "available_options": [
                            "list",
                            "custom_feed"
                        ]
                    }
                }
            }
        },
        {
            "type": "workflow_trigger_definition",
            "id": "contact_tagged",
            "attributes": {
                "name": "contact_tagged",
                "output": {
                    "entity_type": "contact"
                },
                "filters": {
                    "tag_id": {
                        "entity_type": "tag",
                        "required": true,
                        "array": false,
                        "available_options": null
                    }
                },
                "options": {}
            }
        }
    ],
    "meta": {
        "num_results": 2,
        "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429

🔴500Server Error

🔴504Gateway Timeout

Retrieve Workflow Trigger Definitions

Request

Request Code Samples

Responses