HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Create Flow

Create a new flow using an encoded flow definition.

New objects within the flow definition, such as actions, will need to use a
temporary_id field for identification. These will be replaced with traditional id fields
after successful creation.

A successful request will return the new definition to you.

Rate limits:
Burst: 1/s
Steady: 15/m
Daily: 100/d

Scopes:
flows:write

Query Params
array of strings

Request additional fields not included by default in the response. Supported values: 'definition'

additional-fields[flow]
Body Params

Creates a Flow from parameters

object
required
string
required
object
required
string
required

The name of the Flow

object
required

The encoded flow definition. New objects that do not yet exist, such as actions, need to use a temporary_id, not an id.

array
required

Corresponds to the object which triggers the flow. Only one trigger is supported.

triggers*
object
required

Filters for users entering the flow. These filters are used on every action in the flow.

array of objects
required
condition_groups*
array
required
conditions*
array
required

A list of actions that make up the flow. Actions are linked to each other by their ids.

actions*
string
required

The ID of the action that is the entry point of the flow.

Headers
string
required
Defaults to 2025-01-15

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials