Overview
The Workflow Examples endpoint returns pre-built example workflows that illustrate best practices for common use cases. Each example includes a complete workflow definition that can be used as a starting point for your own workflows.Authentication
Requires a valid API key. No special permission scope is needed beyond a valid key.Key Features
- Ready-Made Templates: Complete workflow definitions you can adapt
- Common Patterns: Covers lead routing, enrichment, notifications, and more
- Step-by-Step: Each example shows how actions chain together
- No Credit Cost: This endpoint is free to use
Example Response
Response Fields
Each example indata.items includes:
| Field | Type | Description |
|---|---|---|
name | string | Example workflow name |
description | string | What the workflow does |
category | string | Example category |
workflow | object | Complete workflow definition |
workflow.trigger | object | Trigger configuration for the workflow |
workflow.actions | array | Ordered list of workflow actions |
workflow.actions[].kind | string | Action kind identifier (see List Workflow Actions) |
workflow.actions[].name | string | Human-readable action name |
workflow.actions[].inputs | object | Action input values, which may reference trigger data or previous outputs using {{ !ref(...) }} syntax |
workflow.edges | array | Graph edges connecting the trigger and actions |
Credit Usage
This endpoint is free and does not consume credits.Related Endpoints
- List Workflow Actions to discover all available action kinds
- List Workflow Executions to see execution history for a workflow