Sign in
Application-level workflows

Create a workflow

Creates an application-level workflow.

<div id="admonition-info">ℹ️ <b>You must have an existing <a href="/docs/reference/api/application-level-templates/">template</a> to create a workflow</b>.</div>
post/v3/workflows

Request body

delayinteger

The number of minutes between a trigger_event being met and the workflow sending a message.

is_enabledboolean

When true, indicates that the workflow is enabled.

namestring required

The name of the workflow.

template_idstring required

The ID of the email template the workflow uses.

trigger_event'booking.cancelled' | 'booking.created' | 'booking.pending' | 'booking.reminder' | 'booking.rescheduled' required

The event which triggers the workflow.

Example request

{
  "delay": 5,
  "is_enabled": true,
  "name": "New booking confirmation workflow",
  "template_id": "14c00cc8-648c-4381-ad10-52641d9bac8e",
  "trigger_event": "booking.created",
  "from": {
    "email": "support@example.com",
    "name": "Support"
  }
}

Response

Success. Returns workflow.

request_idstring required

The ID of the request.

Example response

{
  "data": {
    "app_id": "6c45fe5e-0bb6-41b9-9acc-ccb15bfc51eb",
    "date_created": 1756477389,
    "delay": 5,
    "grant_id": "6c45fe5e-0bb6-41b9-9acc-ccb15bfc51eb",
    "id": "b79c82b2-a51b-4c54-8469-28006a43551a",
    "is_enabled": true,
    "name": "New booking confirmation workflow",
    "template_id": "14c00cc8-648c-4381-ad10-52641d9bac8e",
    "trigger_event": "booking.created",
    "from": {
      "email": "support@example.com",
      "name": "Support"
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.