Use Case
Run batch data enrichment and automated processing pipelines. Workflows are ideal for processing many records through multi-step pipelines (e.g., validate emails, enrich companies, export to CSV) without manual intervention.Core Concepts
The Workflows API models pipelines as directed acyclic graphs (DAGs):| Term | Description |
|---|---|
| Workflow | A reusable pipeline definition containing blocks and edges |
| Block | A processing step (e.g., webhook input, enrichment, filtering, export) |
| Edge | A connection between blocks that defines data flow |
| Run | An execution instance of a workflow |
| Job ID | A unique identifier for tracking a workflow run |
Execution Flow
- List workflows — Get available workflows in your organization
- Run workflow — Execute with input data; receive a
job_id - Poll live status — Monitor progress until
completed,failed, orcancelled - Download results — Get signed URLs for result files (CSV)
Workflows starting with a
read_csv block cannot be triggered via API. Use workflows that start with a webhook block for API-triggered runs.Quick Start
Next Steps
- Workflow Management — List, create, update, and delete workflows
- Workflow Execution — Run workflows, poll status, cancel runs, and download results