Journeys - Flownally API Docs

get/journeys

List journeys#

Returns customer journeys that can react to contact events and conversation moments.

Authorization

Scheme

bearerAuth

Required scopes

journey:list

Allowed roles

owner
admin
agent

List journeys in the workspace.

Optional parameters

Name
pageSize
Type
query integer
Description
Optional parameter.
Name
pageToken
Type
query string
Description
Optional parameter.

Responses

Name
200
Type
application/json
Description
List of journeys
Name
default
Type
application/json
Description
Error

Related schemas

Request

GETRequest

curl -G "https://api.flownally.com/v1/journeys" \
  -H "Authorization: Bearer {token}" \
  -d pageSize="{pageSize}" \
  -d pageToken="{pageToken}"

Response

200application/json

{
  "journeys": [
    {
      "id": "jrn_01HV8ZF5T2J4M6N8P0Q2R4S6V8",
      "tenantId": "tn_01HV8Y1N3QPY9X2HBQ1M9E8D0",
      "name": "Post-purchase follow-up",
      "status": "draft",
      "createdAt": "2026-04-30T09:55:00Z",
      "updatedAt": "2026-04-30T10:05:00Z",
      "entryMode": "once"
    }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}

post/journeys

Create journey#

Creates a journey draft. Publish and activate it before contacts can enter.

Authorization

Scheme

bearerAuth

Required scopes

journey:create

Allowed roles

owner
admin
agent

Create a journey in the workspace.

Request body

Send a application/json body. The body is required for this operation.

Required attributes

Name
name
Type
string
Description
Required request attribute.

Optional attributes

Name
definition
Type
WorkflowDefinition
Description
Optional request attribute.
Name
triggerConfig
Type
TriggerConfig
Description
Optional request attribute.
Name
entryMode
Type
EntryMode
Description
Optional request attribute.

Responses

Name
201
Type
application/json
Description
Journey created
Name
default
Type
application/json
Description
Error

Related schemas

Request

POSTRequest

curl -X POST "https://api.flownally.com/v1/journeys" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Post-purchase follow-up",
  "entryMode": "once"
}'

Response

201application/json

{
  "id": "jrn_01HV8ZF5T2J4M6N8P0Q2R4S6V8",
  "tenantId": "tn_01HV8Y1N3QPY9X2HBQ1M9E8D0",
  "name": "Post-purchase follow-up",
  "status": "draft",
  "createdAt": "2026-04-30T09:55:00Z",
  "updatedAt": "2026-04-30T10:05:00Z",
  "entryMode": "once"
}

get/journeys/{id}

Get journey#

Returns a journey draft, its status, and the active version when one is running.

Authorization

Scheme

bearerAuth

Required scopes

journey:read

Allowed roles

owner
admin
agent

Read a journey in the workspace.

Required parameters

Name
id
Type
path string
Description
Required parameter.

Responses

Name
200
Type
application/json
Description
Journey details
Name
default
Type
application/json
Description
Error

Related schemas

Request

GETRequest

curl -X GET "https://api.flownally.com/v1/journeys/{id}" \
  -H "Authorization: Bearer {token}"

Response

200application/json

{
  "id": "jrn_01HV8ZF5T2J4M6N8P0Q2R4S6V8",
  "tenantId": "tn_01HV8Y1N3QPY9X2HBQ1M9E8D0",
  "name": "Post-purchase follow-up",
  "status": "draft",
  "createdAt": "2026-04-30T09:55:00Z",
  "updatedAt": "2026-04-30T10:05:00Z",
  "entryMode": "once"
}

patch/journeys/{id}

Update journey#

Updates a journey draft. Publish again to snapshot changes for activation.

Authorization

Scheme

bearerAuth

Required scopes

journey:update

Allowed roles

owner
admin
agent

Update a journey in the workspace.

Required parameters

Name
id
Type
path string
Description
Required parameter.

Request body

Send a application/json body. The body is required for this operation.

Optional attributes

Name
name
Type
string
Description
Optional request attribute.
Name
definition
Type
WorkflowDefinition
Description
Optional request attribute.
Name
triggerConfig
Type
TriggerConfig
Description
Optional request attribute.
Name
entryMode
Type
EntryMode
Description
Optional request attribute.

Responses

Name
200
Type
application/json
Description
Journey updated
Name
default
Type
application/json
Description
Error

Related schemas

Request

PATCHRequest

curl -X PATCH "https://api.flownally.com/v1/journeys/{id}" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "order_ready",
  "definition": {
    "nodes": [
      {
        "id": "string",
        "type": "start",
        "data": {
          "triggerConfig": {
            "type": "contact_created",
            "conditions": {}
          },
          "entryMode": "once"
        }
      }
    ],
    "edges": [
      {}
    ]
  },
  "triggerConfig": {
    "type": "contact_created",
    "conditions": {}
  },
  "entryMode": "once"
}'

Response

200application/json

{
  "id": "jrn_01HV8ZF5T2J4M6N8P0Q2R4S6V8",
  "tenantId": "tn_01HV8Y1N3QPY9X2HBQ1M9E8D0",
  "name": "Post-purchase follow-up",
  "status": "draft",
  "createdAt": "2026-04-30T09:55:00Z",
  "updatedAt": "2026-04-30T10:05:00Z",
  "entryMode": "once"
}

delete/journeys/{id}

Delete journey#

Deletes a journey. Active journeys must be paused first.

Authorization

Scheme

bearerAuth

Required scopes

journey:delete

Allowed roles

owner
admin
agent

Delete a journey in the workspace.

Required parameters

Name
id
Type
path string
Description
Required parameter.

Responses

Name
204
Description
Journey deleted
Name
default
Type
application/json
Description
Error

Related schemas

Request

DELETERequest

curl -X DELETE "https://api.flownally.com/v1/journeys/{id}" \
  -H "Authorization: Bearer {token}"

Response

204

204 Journey deleted

post/journeys/{id}/publish

Publish journey#

Validates and snapshots the current draft definition as an immutable version.

Authorization

Scheme

bearerAuth

Required scopes

journey:publish

Allowed roles

owner
admin
agent

Publish a journey version.

Required parameters

Name
id
Type
path string
Description
Required parameter.

Responses

Name
200
Type
application/json
Description
Version published
Name
default
Type
application/json
Description
Error

Related schemas

Request

POSTRequest

curl -X POST "https://api.flownally.com/v1/journeys/{id}/publish" \
  -H "Authorization: Bearer {token}"

Response

200application/json

{
  "id": "string",
  "journeyId": "string",
  "definition": {
    "nodes": [
      {
        "id": "string",
        "type": "start",
        "data": {
          "triggerConfig": {
            "type": "contact_created",
            "conditions": {}
          },
          "entryMode": "once"
        }
      }
    ],
    "edges": [
      {}
    ]
  },
  "triggerConfig": {
    "type": "contact_created",
    "conditions": {}
  },
  "entryMode": "once",
  "createdAt": "2026-04-27T00:00:00.000Z"
}

post/journeys/{id}/activate

Activate journey#

Activates a journey to start processing events. Requires published version.

Authorization

Scheme

bearerAuth

Required scopes

journey:activate

Allowed roles

owner
admin
agent

Activate a journey.

Required parameters

Name
id
Type
path string
Description
Required parameter.

Responses

Name
200
Type
application/json
Description
Journey activated
Name
default
Type
application/json
Description
Error

Related schemas

Request

POSTRequest

curl -X POST "https://api.flownally.com/v1/journeys/{id}/activate" \
  -H "Authorization: Bearer {token}"

Response

200application/json

{
  "id": "jrn_01HV8ZF5T2J4M6N8P0Q2R4S6V8",
  "tenantId": "tn_01HV8Y1N3QPY9X2HBQ1M9E8D0",
  "name": "Post-purchase follow-up",
  "status": "draft",
  "createdAt": "2026-04-30T09:55:00Z",
  "updatedAt": "2026-04-30T10:05:00Z",
  "entryMode": "once"
}

post/journeys/{id}/pause

Pause journey#

Pauses an active journey. Running instances continue to completion.

Authorization

Scheme

bearerAuth

Required scopes

journey:activate

Allowed roles

owner
admin
agent

Pause a journey.

Required parameters

Name
id
Type
path string
Description
Required parameter.

Responses

Name
200
Type
application/json
Description
Journey paused
Name
default
Type
application/json
Description
Error

Related schemas

Request

POSTRequest

curl -X POST "https://api.flownally.com/v1/journeys/{id}/pause" \
  -H "Authorization: Bearer {token}"

Response

200application/json

{
  "id": "jrn_01HV8ZF5T2J4M6N8P0Q2R4S6V8",
  "tenantId": "tn_01HV8Y1N3QPY9X2HBQ1M9E8D0",
  "name": "Post-purchase follow-up",
  "status": "draft",
  "createdAt": "2026-04-30T09:55:00Z",
  "updatedAt": "2026-04-30T10:05:00Z",
  "entryMode": "once"
}

get/journeys/{id}/versions

List journey versions#

Authorization

Scheme

bearerAuth

Required scopes

journey:read

Allowed roles

owner
admin
agent

List journey versions.

Required parameters

Name
id
Type
path string
Description
Required parameter.

Optional parameters

Name
pageSize
Type
query integer
Description
Optional parameter.
Name
pageToken
Type
query string
Description
Optional parameter.

Responses

Name
200
Type
application/json
Description
List of versions
Name
default
Type
application/json
Description
Error

Related schemas

Request

GETRequest

curl -G "https://api.flownally.com/v1/journeys/{id}/versions" \
  -H "Authorization: Bearer {token}" \
  -d pageSize="{pageSize}" \
  -d pageToken="{pageToken}"

Response

200application/json

{
  "journeyVersions": [
    {
      "id": "string",
      "journeyId": "string",
      "definition": {
        "nodes": [
          {
            "id": "string",
            "type": "start",
            "data": {
              "triggerConfig": {
                "type": "contact_created",
                "conditions": {}
              },
              "entryMode": "once"
            }
          }
        ],
        "edges": [
          {}
        ]
      },
      "triggerConfig": {
        "type": "contact_created",
        "conditions": {}
      },
      "entryMode": "once",
      "createdAt": "2026-04-27T00:00:00.000Z"
    }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}

get/journeys/versions/{versionId}

Get journey version#

Authorization

Scheme

bearerAuth

Required scopes

journey:read

Allowed roles

owner
admin
agent

Read a journey version.

Required parameters

Name
versionId
Type
path string
Description
Required parameter.

Responses

Name
200
Type
application/json
Description
Version details
Name
default
Type
application/json
Description
Error

Related schemas

Request

GETRequest

curl -X GET "https://api.flownally.com/v1/journeys/versions/{versionId}" \
  -H "Authorization: Bearer {token}"

Response

200application/json

{
  "id": "string",
  "journeyId": "string",
  "definition": {
    "nodes": [
      {
        "id": "string",
        "type": "start",
        "data": {
          "triggerConfig": {
            "type": "contact_created",
            "conditions": {}
          },
          "entryMode": "once"
        }
      }
    ],
    "edges": [
      {}
    ]
  },
  "triggerConfig": {
    "type": "contact_created",
    "conditions": {}
  },
  "entryMode": "once",
  "createdAt": "2026-04-27T00:00:00.000Z"
}