Retrieve Workflow Templates

Retrieve the pre-built workflows you can start from, each a ready-made definition with the values that depend on your account left out.

A template is the quickest route to a working workflow: instead of wiring triggers and steps yourself, take a template's definition, fill in its variables, and post the result to Create Workflow.

Wherever a value has to be supplied, the definition carries a {{variables.<name>}} placeholder, and the matching entry under variables says what that value is for and what it accepts — its entity_type, whether it takes a list (array), and the values it is restricted to (available_options), if any.

A placeholder always takes up the whole value it stands in for and is never part of a longer string, so filling one in means replacing the whole string. That is also what lets a variable hold an array or a number rather than only text. One variable may appear in more than one place — a CRM connection used by two export steps is one variable — and the value you supply goes into every placeholder that names it.

A definition still holding a placeholder is not a valid definition. It is accepted by Create Workflow, which stores a definition without validating it, but the workflow cannot be enabled until every placeholder is replaced.

The list is the same for every account — it describes what the platform ships, not what the account has set up. Templates are added and revised over time, so treat the list as open-ended; a template's id is stable and can be stored.

Credit Note: Retrieving templates does not consume credits.

INFO

Requires the workflows:read OAuth2 scope.

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "data": [
        {
            "type": "workflow_template",
            "id": "template-prospects-to-n8n-automation",
            "attributes": {
                "name": "Send qualified prospects to n8n Automation",
                "description": "Automatically send companies to a n8n automation when they're added to a list.",
                "categories": [
                    "outbound"
                ],
                "workflow_type": "company",
                "definition_version": "V1",
                "definition": {
                    "triggers": [
                        {
                            "name": "organization_added_to_list",
                            "filters": [
                                {
                                    "attribute": "list_id",
                                    "value": "{{variables.trigger_list_id}}"
                                }
                            ],
                            "options": {}
                        }
                    ],
                    "order": {
                        "trigger": [
                            "step-1-send-webhook"
                        ],
                        "step-1-send-webhook": []
                    },
                    "steps": {
                        "step-1-send-webhook": {
                            "action_name": "send_organization_to_webhook",
                            "options": {
                                "url": "{{variables.webhook_url}}"
                            }
                        }
                    }
                },
                "variables": {
                    "trigger_list_id": {
                        "description": "The list to watch. A company entering it starts the workflow.",
                        "entity_type": "company_list",
                        "required": true,
                        "array": false,
                        "available_options": null
                    },
                    "webhook_url": {
                        "description": "The n8n webhook the company is posted to.",
                        "entity_type": "string",
                        "required": true,
                        "array": false,
                        "available_options": null
                    }
                }
            }
        },
        {
            "type": "workflow_template",
            "id": "template-alert-sales-lost-opportunity",
            "attributes": {
                "name": "Alert sales when a lost opportunity visits high intent pages",
                "description": "Get notified when a lost opportunity shows renewed interest on your website.",
                "categories": [
                    "rebound"
                ],
                "workflow_type": "company",
                "definition_version": "V1",
                "definition": {
                    "triggers": [
                        {
                            "name": "organization_added_to_list",
                            "filters": [
                                {
                                    "attribute": "list_id",
                                    "value": "{{variables.custom_feed_id}}"
                                }
                            ],
                            "options": {
                                "type": "custom_feed"
                            }
                        }
                    ],
                    "order": {
                        "trigger": [
                            {
                                "cliftonite_filters": {
                                    "integrations_opportunity_status": [
                                        "lost"
                                    ]
                                },
                                "step_if_true": "step-1-send-slack"
                            }
                        ],
                        "step-1-send-slack": []
                    },
                    "steps": {
                        "step-1-send-slack": {
                            "action_name": "send_organization_to_slack",
                            "options": {
                                "integration_connection_id": "{{variables.slack_connection_id}}",
                                "channel_id": "{{variables.slack_channel_id}}"
                            }
                        }
                    }
                },
                "variables": {
                    "custom_feed_id": {
                        "description": "The custom feed to watch. A company entering it starts the workflow.",
                        "entity_type": "company_list",
                        "required": true,
                        "array": false,
                        "available_options": null
                    },
                    "slack_connection_id": {
                        "description": "The Slack connection the alert is sent through.",
                        "entity_type": "integer",
                        "required": true,
                        "array": false,
                        "available_options": null
                    },
                    "slack_channel_id": {
                        "description": "The Slack channel the alert is posted to.",
                        "entity_type": "string",
                        "required": true,
                        "array": false,
                        "available_options": null
                    }
                }
            }
        }
    ],
    "meta": {
        "num_results": 2,
        "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429

🔴500Server Error

🔴504Gateway Timeout

Retrieve Workflow Templates

Request

Request Code Samples

Responses