Skip to main content
POST
Create Workflow

Request

Headers

string
Optional UUID for retry deduplication within 24 hours.

Body Parameters

string
required
Human-readable name. 1 - 120 characters.
string
required
Entity type to listen on: contact, deal, task, email, or meeting.
string
required
Field on the entity to evaluate (e.g. status, stage_id, tags).
string
required
Operator: equals, not_equals, contains, changed, changed_to, greater_than, less_than.
string
required
Value to compare against. For changed no value is needed but the parameter is still required as an empty string.
string
required
Action to perform: send_email, create_task, send_channel_message, webhook, update_field.
object
required
Action-specific configuration. Accepts merge tokens referencing the triggering entity (e.g. {{deal.name}}).
integer
default:"100"
Circuit-breaker threshold. When exceeded, the workflow auto-disables and raises an alert.
boolean
default:"true"
Whether the workflow should be active upon creation.

Response

object
The created workflow record (same shape as GET /v1/workflows/{id}).
Responses include X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID.

Example Response

Errors