PushizoDocs
API reference

Journeys

Journeys — 20 operations (GET /v1/apps/{appId}/journeys, POST /v1/apps/{appId}/journeys, GET /v1/apps/{appId}/journeys/{journeyId}, …). Generated from the OpenAPI 3.1.0 contract.

Journey definition, versioning, publish/pause, runs, runs per user and statistics. See the “Journeys” section for the graph format.

Base URL: https://api.pushizo.com · Tag: journeys · Interactive docs (Scalar)

Operations

MethodPathOperation
GET/v1/apps/{appId}/journeysList journeys
POST/v1/apps/{appId}/journeysCreate a journey (draft)
GET/v1/apps/{appId}/journeys/{journeyId}Journey details
PATCH/v1/apps/{appId}/journeys/{journeyId}Name / description
DELETE/v1/apps/{appId}/journeys/{journeyId}Delete a journey that has never been published
PUT/v1/apps/{appId}/journeys/{journeyId}/draftSave the draft
PATCH/v1/apps/{appId}/journeys/{journeyId}/nodes/{nodeId}Update a node in the draft
GET/v1/apps/{appId}/journeys/{journeyId}/versionsVersions
POST/v1/apps/{appId}/journeys/{journeyId}/versions/{version}/restoreRestore an old version as a new draft (the published version does not change)
POST/v1/apps/{appId}/journeys/{journeyId}/publishPublish
POST/v1/apps/{appId}/journeys/{journeyId}/pausePause
POST/v1/apps/{appId}/journeys/{journeyId}/resumeResume
POST/v1/apps/{appId}/journeys/{journeyId}/archiveArchive
POST/v1/apps/{appId}/journeys/{journeyId}/duplicateCopy
GET/v1/apps/{appId}/journeys/{journeyId}/statsPer-node statistics
GET/v1/apps/{appId}/journeys/{journeyId}/runsList runs
POST/v1/apps/{appId}/journeys/{journeyId}/runsEnter a user into the journey (external_id, user_id or alias; context as Liquid custom_data)
GET/v1/apps/{appId}/journeys/{journeyId}/runs/{runId}Run details and steps
DELETE/v1/apps/{appId}/journeys/{journeyId}/runs/{runId}Terminate the run
GET/v1/apps/{appId}/users/by/{label}/{value}/journeysJourney runs of the user

Details

List journeys

GET/v1/apps/{appId}/journeysTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
statusqueryenumNoValues: "draft", "active", "paused", "archived""draft"
qquerystringNoLength: 0–100"ayse"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: JourneyPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].statusenumYesValues: "draft", "active", "paused", "archived"
data[].current_versioninteger | nullYes
data[].draft_versioninteger | nullYes
data[].trigger_kindstring | nullYes
data[].published_atstring | nullYes
data[].created_bystring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
data[].summaryobjectYes
data[].summary.runs_totalintegerYes
data[].summary.activeintegerYes
data[].summary.completedintegerYes
data[].summary.exitedintegerYes
data[].summary.failedintegerYes
data[].summary.goal_reachedintegerYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "status": "draft",
      "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "description": "Sipariş durumu güncellemeleri",
      "current_version": 1,
      "draft_version": 1,
      "trigger_kind": "örnek",
      "published_at": "örnek",
      "created_by": "örnek",
      "created_at": "örnek",
      "updated_at": "örnek",
      "summary": {
        "runs_total": 1,
        "active": 1,
        "completed": 1,
        "exited": 1,
        "failed": 1,
        "goal_reached": 1
      }
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Create a journey (draft)

POST/v1/apps/{appId}/journeysTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

FieldTypeRequiredDescription
namestringYesLength: 2–120
descriptionstringNoLength: 0–500
graphobjectNoReact Flow compatible journey graph: { nodes: [{ id, type, position, data }], edges: [{ id, source, target, sourceHandle }] } (docs/journeys.md)
graph.nodesarray<object>Yes
graph.edgesarray<object>Yes
settingsobjectNoRe-entry, new entrants only, exit rules, exit tags, goals, schedule (docs/journeys.md)

Example:

{
  "name": "Sipariş bildirimleri",
  "description": "Sipariş durumu güncellemeleri",
  "graph": {
    "nodes": [
      {}
    ],
    "edges": [
      {}
    ]
  },
  "settings": {}
}

Responses

201 — Success.

Schema: JourneyDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
statusenumYesValues: "draft", "active", "paused", "archived"
current_versioninteger | nullYes
draft_versioninteger | nullYes
trigger_kindstring | nullYes
published_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes
editingobjectYes
editing.versionintegerYes
editing.graphmap<string, any>Yes
editing.settingsmap<string, any>Yes
editing.published_atstring | nullYes
editing.published_bystring | nullYes
editing.created_atstringYes
editing.updated_atstringYes
issuesarray<object>Yes
issues[].codestringYes
issues[].node_idstringNo
issues[].edge_idstringNo
issues[].messagestringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "current_version": 1,
  "draft_version": 1,
  "trigger_kind": "örnek",
  "published_at": "örnek",
  "created_by": "örnek",
  "created_at": "örnek",
  "updated_at": "örnek",
  "summary": {
    "runs_total": 1,
    "active": 1,
    "completed": 1,
    "exited": 1,
    "failed": 1,
    "goal_reached": 1
  },
  "editing": {
    "version": 1,
    "graph": {
      "key": "örnek"
    },
    "settings": {},
    "published_at": "örnek",
    "published_by": "örnek",
    "created_at": "örnek",
    "updated_at": "örnek"
  },
  "issues": [
    {
      "code": "örnek",
      "message": "Takip bağlantısı içeride",
      "node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "edge_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "description": "Sipariş durumu güncellemeleri",
  "graph": {
    "nodes": [
      {}
    ],
    "edges": [
      {}
    ]
  },
  "settings": {}
}'

Journey details

GET/v1/apps/{appId}/journeys/{journeyId}Try it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: JourneyDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
statusenumYesValues: "draft", "active", "paused", "archived"
current_versioninteger | nullYes
draft_versioninteger | nullYes
trigger_kindstring | nullYes
published_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes
editingobjectYes
editing.versionintegerYes
editing.graphmap<string, any>Yes
editing.settingsmap<string, any>Yes
editing.published_atstring | nullYes
editing.published_bystring | nullYes
editing.created_atstringYes
editing.updated_atstringYes
issuesarray<object>Yes
issues[].codestringYes
issues[].node_idstringNo
issues[].edge_idstringNo
issues[].messagestringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "current_version": 1,
  "draft_version": 1,
  "trigger_kind": "örnek",
  "published_at": "örnek",
  "created_by": "örnek",
  "created_at": "örnek",
  "updated_at": "örnek",
  "summary": {
    "runs_total": 1,
    "active": 1,
    "completed": 1,
    "exited": 1,
    "failed": 1,
    "goal_reached": 1
  },
  "editing": {
    "version": 1,
    "graph": {
      "key": "örnek"
    },
    "settings": {},
    "published_at": "örnek",
    "published_by": "örnek",
    "created_at": "örnek",
    "updated_at": "örnek"
  },
  "issues": [
    {
      "code": "örnek",
      "message": "Takip bağlantısı içeride",
      "node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "edge_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Name / description

PATCH/v1/apps/{appId}/journeys/{journeyId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateJourneyDto

FieldTypeRequiredDescription
namestringNoLength: 2–120
descriptionstring | nullNo

Example:

{
  "name": "Sipariş bildirimleri",
  "description": "Sipariş durumu güncellemeleri"
}

Responses

200 — Success.

Schema: JourneyDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
statusenumYesValues: "draft", "active", "paused", "archived"
current_versioninteger | nullYes
draft_versioninteger | nullYes
trigger_kindstring | nullYes
published_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes
editingobjectYes
editing.versionintegerYes
editing.graphmap<string, any>Yes
editing.settingsmap<string, any>Yes
editing.published_atstring | nullYes
editing.published_bystring | nullYes
editing.created_atstringYes
editing.updated_atstringYes
issuesarray<object>Yes
issues[].codestringYes
issues[].node_idstringNo
issues[].edge_idstringNo
issues[].messagestringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "current_version": 1,
  "draft_version": 1,
  "trigger_kind": "örnek",
  "published_at": "örnek",
  "created_by": "örnek",
  "created_at": "örnek",
  "updated_at": "örnek",
  "summary": {
    "runs_total": 1,
    "active": 1,
    "completed": 1,
    "exited": 1,
    "failed": 1,
    "goal_reached": 1
  },
  "editing": {
    "version": 1,
    "graph": {
      "key": "örnek"
    },
    "settings": {},
    "published_at": "örnek",
    "published_by": "örnek",
    "created_at": "örnek",
    "updated_at": "örnek"
  },
  "issues": [
    {
      "code": "örnek",
      "message": "Takip bağlantısı içeride",
      "node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "edge_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "description": "Sipariş durumu güncellemeleri"
}'

Delete a journey that has never been published

DELETE/v1/apps/{appId}/journeys/{journeyId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Save the draft

PUT/v1/apps/{appId}/journeys/{journeyId}/draftTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

FieldTypeRequiredDescription
graphobjectYesReact Flow compatible journey graph: { nodes: [{ id, type, position, data }], edges: [{ id, source, target, sourceHandle }] } (docs/journeys.md)
graph.nodesarray<object>Yes
graph.edgesarray<object>Yes
settingsobjectNoRe-entry, new entrants only, exit rules, exit tags, goals, schedule (docs/journeys.md)

Example:

{
  "graph": {
    "nodes": [
      {}
    ],
    "edges": [
      {}
    ]
  },
  "settings": {}
}

Responses

200 — Success.

Schema: JourneyDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
statusenumYesValues: "draft", "active", "paused", "archived"
current_versioninteger | nullYes
draft_versioninteger | nullYes
trigger_kindstring | nullYes
published_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes
editingobjectYes
editing.versionintegerYes
editing.graphmap<string, any>Yes
editing.settingsmap<string, any>Yes
editing.published_atstring | nullYes
editing.published_bystring | nullYes
editing.created_atstringYes
editing.updated_atstringYes
issuesarray<object>Yes
issues[].codestringYes
issues[].node_idstringNo
issues[].edge_idstringNo
issues[].messagestringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "current_version": 1,
  "draft_version": 1,
  "trigger_kind": "örnek",
  "published_at": "örnek",
  "created_by": "örnek",
  "created_at": "örnek",
  "updated_at": "örnek",
  "summary": {
    "runs_total": 1,
    "active": 1,
    "completed": 1,
    "exited": 1,
    "failed": 1,
    "goal_reached": 1
  },
  "editing": {
    "version": 1,
    "graph": {
      "key": "örnek"
    },
    "settings": {},
    "published_at": "örnek",
    "published_by": "örnek",
    "created_at": "örnek",
    "updated_at": "örnek"
  },
  "issues": [
    {
      "code": "örnek",
      "message": "Takip bağlantısı içeride",
      "node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "edge_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W/draft" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "graph": {
    "nodes": [
      {}
    ],
    "edges": [
      {}
    ]
  },
  "settings": {}
}'

Update a node in the draft

PATCH/v1/apps/{appId}/journeys/{journeyId}/nodes/{nodeId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
nodeIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateNodeDto

FieldTypeRequiredDescription
datamap<string, any>No
positionobjectNo
position.xnumberYes
position.ynumberYes

Example:

{
  "data": {
    "order_id": "1001"
  },
  "position": {
    "x": 1.5,
    "y": 1.5
  }
}

Responses

200 — Success.

Schema: JourneyDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
statusenumYesValues: "draft", "active", "paused", "archived"
current_versioninteger | nullYes
draft_versioninteger | nullYes
trigger_kindstring | nullYes
published_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes
editingobjectYes
editing.versionintegerYes
editing.graphmap<string, any>Yes
editing.settingsmap<string, any>Yes
editing.published_atstring | nullYes
editing.published_bystring | nullYes
editing.created_atstringYes
editing.updated_atstringYes
issuesarray<object>Yes
issues[].codestringYes
issues[].node_idstringNo
issues[].edge_idstringNo
issues[].messagestringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "current_version": 1,
  "draft_version": 1,
  "trigger_kind": "örnek",
  "published_at": "örnek",
  "created_by": "örnek",
  "created_at": "örnek",
  "updated_at": "örnek",
  "summary": {
    "runs_total": 1,
    "active": 1,
    "completed": 1,
    "exited": 1,
    "failed": 1,
    "goal_reached": 1
  },
  "editing": {
    "version": 1,
    "graph": {
      "key": "örnek"
    },
    "settings": {},
    "published_at": "örnek",
    "published_by": "örnek",
    "created_at": "örnek",
    "updated_at": "örnek"
  },
  "issues": [
    {
      "code": "örnek",
      "message": "Takip bağlantısı içeride",
      "node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "edge_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W/nodes/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "data": {
    "order_id": "1001"
  },
  "position": {
    "x": 1.5,
    "y": 1.5
  }
}'

Versions

GET/v1/apps/{appId}/journeys/{journeyId}/versionsTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: JourneyVersionList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].versionintegerYes
data[].graphmap<string, any>Yes
data[].settingsmap<string, any>Yes
data[].published_atstring | nullYes
data[].published_bystring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

Example response:

{
  "data": [
    {
      "version": 1,
      "graph": {
        "key": "örnek"
      },
      "settings": {},
      "published_at": "örnek",
      "published_by": "örnek",
      "created_at": "örnek",
      "updated_at": "örnek"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W/versions" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Restore an old version as a new draft (the published version does not change)

POST/v1/apps/{appId}/journeys/{journeyId}/versions/{version}/restoreTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
versionpathnumberYes1.5
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: JourneyDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
statusenumYesValues: "draft", "active", "paused", "archived"
current_versioninteger | nullYes
draft_versioninteger | nullYes
trigger_kindstring | nullYes
published_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes
editingobjectYes
editing.versionintegerYes
editing.graphmap<string, any>Yes
editing.settingsmap<string, any>Yes
editing.published_atstring | nullYes
editing.published_bystring | nullYes
editing.created_atstringYes
editing.updated_atstringYes
issuesarray<object>Yes
issues[].codestringYes
issues[].node_idstringNo
issues[].edge_idstringNo
issues[].messagestringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "current_version": 1,
  "draft_version": 1,
  "trigger_kind": "örnek",
  "published_at": "örnek",
  "created_by": "örnek",
  "created_at": "örnek",
  "updated_at": "örnek",
  "summary": {
    "runs_total": 1,
    "active": 1,
    "completed": 1,
    "exited": 1,
    "failed": 1,
    "goal_reached": 1
  },
  "editing": {
    "version": 1,
    "graph": {
      "key": "örnek"
    },
    "settings": {},
    "published_at": "örnek",
    "published_by": "örnek",
    "created_at": "örnek",
    "updated_at": "örnek"
  },
  "issues": [
    {
      "code": "örnek",
      "message": "Takip bağlantısı içeride",
      "node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "edge_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W/versions/örnek/restore" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Publish

POST/v1/apps/{appId}/journeys/{journeyId}/publishTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: JourneyPublishResult

FieldTypeRequiredDescription
journeyobjectYes
journey.idstringYes
journey.app_idstringYes
journey.namestringYes
journey.descriptionstring | nullYes
journey.statusenumYesValues: "draft", "active", "paused", "archived"
journey.current_versioninteger | nullYes
journey.draft_versioninteger | nullYes
journey.trigger_kindstring | nullYes
journey.published_atstring | nullYes
journey.created_bystring | nullYes
journey.created_atstringYes
journey.updated_atstringYes
journey.summaryobjectYes
journey.summary.runs_totalintegerYes
journey.summary.activeintegerYes
journey.summary.completedintegerYes
journey.summary.exitedintegerYes
journey.summary.failedintegerYes
journey.summary.goal_reachedintegerYes
versionintegerYes
issuesarray<object>Yes
issues[].codestringYes
issues[].node_idstringNo
issues[].edge_idstringNo
issues[].messagestringYes

Example response:

{
  "journey": {
    "name": "Sipariş bildirimleri",
    "status": "draft",
    "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "description": "Sipariş durumu güncellemeleri",
    "current_version": 1,
    "draft_version": 1,
    "trigger_kind": "örnek",
    "published_at": "örnek",
    "created_by": "örnek",
    "created_at": "örnek",
    "updated_at": "örnek",
    "summary": {
      "runs_total": 1,
      "active": 1,
      "completed": 1,
      "exited": 1,
      "failed": 1,
      "goal_reached": 1
    }
  },
  "version": 1,
  "issues": [
    {
      "code": "örnek",
      "message": "Takip bağlantısı içeride",
      "node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "edge_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W/publish" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Pause

POST/v1/apps/{appId}/journeys/{journeyId}/pauseTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: JourneyDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
statusenumYesValues: "draft", "active", "paused", "archived"
current_versioninteger | nullYes
draft_versioninteger | nullYes
trigger_kindstring | nullYes
published_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes
editingobjectYes
editing.versionintegerYes
editing.graphmap<string, any>Yes
editing.settingsmap<string, any>Yes
editing.published_atstring | nullYes
editing.published_bystring | nullYes
editing.created_atstringYes
editing.updated_atstringYes
issuesarray<object>Yes
issues[].codestringYes
issues[].node_idstringNo
issues[].edge_idstringNo
issues[].messagestringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "current_version": 1,
  "draft_version": 1,
  "trigger_kind": "örnek",
  "published_at": "örnek",
  "created_by": "örnek",
  "created_at": "örnek",
  "updated_at": "örnek",
  "summary": {
    "runs_total": 1,
    "active": 1,
    "completed": 1,
    "exited": 1,
    "failed": 1,
    "goal_reached": 1
  },
  "editing": {
    "version": 1,
    "graph": {
      "key": "örnek"
    },
    "settings": {},
    "published_at": "örnek",
    "published_by": "örnek",
    "created_at": "örnek",
    "updated_at": "örnek"
  },
  "issues": [
    {
      "code": "örnek",
      "message": "Takip bağlantısı içeride",
      "node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "edge_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W/pause" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Resume

POST/v1/apps/{appId}/journeys/{journeyId}/resumeTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: JourneyDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
statusenumYesValues: "draft", "active", "paused", "archived"
current_versioninteger | nullYes
draft_versioninteger | nullYes
trigger_kindstring | nullYes
published_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes
editingobjectYes
editing.versionintegerYes
editing.graphmap<string, any>Yes
editing.settingsmap<string, any>Yes
editing.published_atstring | nullYes
editing.published_bystring | nullYes
editing.created_atstringYes
editing.updated_atstringYes
issuesarray<object>Yes
issues[].codestringYes
issues[].node_idstringNo
issues[].edge_idstringNo
issues[].messagestringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "current_version": 1,
  "draft_version": 1,
  "trigger_kind": "örnek",
  "published_at": "örnek",
  "created_by": "örnek",
  "created_at": "örnek",
  "updated_at": "örnek",
  "summary": {
    "runs_total": 1,
    "active": 1,
    "completed": 1,
    "exited": 1,
    "failed": 1,
    "goal_reached": 1
  },
  "editing": {
    "version": 1,
    "graph": {
      "key": "örnek"
    },
    "settings": {},
    "published_at": "örnek",
    "published_by": "örnek",
    "created_at": "örnek",
    "updated_at": "örnek"
  },
  "issues": [
    {
      "code": "örnek",
      "message": "Takip bağlantısı içeride",
      "node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "edge_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W/resume" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Archive

POST/v1/apps/{appId}/journeys/{journeyId}/archiveTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: JourneyDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
statusenumYesValues: "draft", "active", "paused", "archived"
current_versioninteger | nullYes
draft_versioninteger | nullYes
trigger_kindstring | nullYes
published_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes
editingobjectYes
editing.versionintegerYes
editing.graphmap<string, any>Yes
editing.settingsmap<string, any>Yes
editing.published_atstring | nullYes
editing.published_bystring | nullYes
editing.created_atstringYes
editing.updated_atstringYes
issuesarray<object>Yes
issues[].codestringYes
issues[].node_idstringNo
issues[].edge_idstringNo
issues[].messagestringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "current_version": 1,
  "draft_version": 1,
  "trigger_kind": "örnek",
  "published_at": "örnek",
  "created_by": "örnek",
  "created_at": "örnek",
  "updated_at": "örnek",
  "summary": {
    "runs_total": 1,
    "active": 1,
    "completed": 1,
    "exited": 1,
    "failed": 1,
    "goal_reached": 1
  },
  "editing": {
    "version": 1,
    "graph": {
      "key": "örnek"
    },
    "settings": {},
    "published_at": "örnek",
    "published_by": "örnek",
    "created_at": "örnek",
    "updated_at": "örnek"
  },
  "issues": [
    {
      "code": "örnek",
      "message": "Takip bağlantısı içeride",
      "node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "edge_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W/archive" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Copy

POST/v1/apps/{appId}/journeys/{journeyId}/duplicateTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

201 — Success.

Schema: JourneyDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
statusenumYesValues: "draft", "active", "paused", "archived"
current_versioninteger | nullYes
draft_versioninteger | nullYes
trigger_kindstring | nullYes
published_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes
editingobjectYes
editing.versionintegerYes
editing.graphmap<string, any>Yes
editing.settingsmap<string, any>Yes
editing.published_atstring | nullYes
editing.published_bystring | nullYes
editing.created_atstringYes
editing.updated_atstringYes
issuesarray<object>Yes
issues[].codestringYes
issues[].node_idstringNo
issues[].edge_idstringNo
issues[].messagestringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "current_version": 1,
  "draft_version": 1,
  "trigger_kind": "örnek",
  "published_at": "örnek",
  "created_by": "örnek",
  "created_at": "örnek",
  "updated_at": "örnek",
  "summary": {
    "runs_total": 1,
    "active": 1,
    "completed": 1,
    "exited": 1,
    "failed": 1,
    "goal_reached": 1
  },
  "editing": {
    "version": 1,
    "graph": {
      "key": "örnek"
    },
    "settings": {},
    "published_at": "örnek",
    "published_by": "örnek",
    "created_at": "örnek",
    "updated_at": "örnek"
  },
  "issues": [
    {
      "code": "örnek",
      "message": "Takip bağlantısı içeride",
      "node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "edge_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W/duplicate" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Per-node statistics

GET/v1/apps/{appId}/journeys/{journeyId}/statsTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
versionqueryintegerNoRange: 1–∞1
all_versionsqueryenumNoValues: "true", "false""true"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: JourneyStats

FieldTypeRequiredDescription
versioninteger | nullYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes
summary.waitingintegerYes
summary.goal_conversion_ratenumberYes
nodesarray<object>Yes
nodes[].node_idstringYes
nodes[].node_typestringYes
nodes[].enteredintegerYes
nodes[].completedintegerYes
nodes[].waiting_nowintegerYes
nodes[].skippedintegerYes
nodes[].failedintegerYes
nodes[].branchesmap<string, integer>Yes
nodes[].messagesmap<string, integer>No
nodes[].variantsarray<object>No
nodes[].variants[].variant_idstringYes
nodes[].variants[].sentintegerYes
nodes[].variants[].openedintegerYes
nodes[].variants[].clickedintegerYes
nodes[].variants[].convertedintegerYes
nodes[].variants[].winnerbooleanYes
goalsarray<object>Yes
goals[].goal_idstringYes
goals[].reachedintegerYes
exit_reasonsmap<string, integer>Yes

Example response:

{
  "version": 1,
  "summary": {
    "runs_total": 1,
    "active": 1,
    "completed": 1,
    "exited": 1,
    "failed": 1,
    "goal_reached": 1,
    "waiting": 1,
    "goal_conversion_rate": 1.5
  },
  "nodes": [
    {
      "node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "node_type": "örnek",
      "entered": 1,
      "completed": 1,
      "waiting_now": 1,
      "skipped": 1,
      "failed": 1,
      "branches": {
        "key": 150
      },
      "messages": {
        "key": 150
      },
      "variants": [
        {
          "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "sent": 1,
          "opened": 1,
          "clicked": 1,
          "converted": 1,
          "winner": true
        }
      ]
    }
  ],
  "goals": [
    {
      "goal_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "reached": 1
    }
  ],
  "exit_reasons": {
    "key": 150
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W/stats" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

List runs

GET/v1/apps/{appId}/journeys/{journeyId}/runsTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
statusqueryenumNoValues: "active", "waiting", "completed", "exited", "failed""active"
user_idquerystringNoLength: 0–64"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
versionqueryintegerNoRange: 1–∞1
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: JourneyRunPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].journey_idstringYes
data[].versionintegerYes
data[].user_idstringYes
data[].external_idstring | nullYes
data[].statusenumYesValues: "active", "waiting", "completed", "exited", "failed"
data[].current_node_idstring | nullYes
data[].next_action_atstring | nullYes
data[].entered_atstringYes
data[].completed_atstring | nullYes
data[].exit_reasonstring | nullYes
data[].goal_idstring | nullYes
data[].goal_reached_atstring | nullYes
data[].contextmap<string, any>Yes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "status": "active",
      "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "journey_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "version": 1,
      "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "external_id": "user_42",
      "current_node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "next_action_at": "örnek",
      "entered_at": "örnek",
      "completed_at": "örnek",
      "exit_reason": "örnek",
      "goal_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "goal_reached_at": "örnek",
      "context": {
        "key": "örnek"
      }
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W/runs?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Enter a user into the journey (external_id, user_id or alias; context as Liquid custom_data)

POST/v1/apps/{appId}/journeys/{journeyId}/runsTry it (interactive API docs, new tab)

Authentication: API key — scope notifications:write (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: TriggerRunDto

FieldTypeRequiredDescription
external_idstringNoLength: 1–255
user_idstringNoLength: 1–64
aliasobjectNo
alias.labelstringYesLength: 1–50
alias.valuestringYesLength: 1–255
contextmap<string, any>No

Example:

{
  "external_id": "user_42",
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "alias": {
    "label": "external_id",
    "value": "user_42"
  },
  "context": {
    "key": "örnek"
  }
}

Responses

201 — Success.

Schema: JourneyTriggerResult

FieldTypeRequiredDescription
enteredbooleanYes
runobject | nullYes
reasonenum | nullYes

Example response:

{
  "entered": true,
  "run": {
    "status": "active",
    "id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "journey_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "version": 1,
    "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "external_id": "user_42",
    "current_node_id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "next_action_at": "örnek",
    "entered_at": "örnek",
    "completed_at": "örnek",
    "exit_reason": "örnek",
    "goal_id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "goal_reached_at": "örnek",
    "context": {
      "key": "örnek"
    }
  },
  "reason": "inactive"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W/runs" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "external_id": "user_42",
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "alias": {
    "label": "external_id",
    "value": "user_42"
  },
  "context": {
    "key": "örnek"
  }
}'

Run details and steps

GET/v1/apps/{appId}/journeys/{journeyId}/runs/{runId}Try it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
runIdpathstringYes"run_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: JourneyRunDetail

FieldTypeRequiredDescription
idstringYes
journey_idstringYes
versionintegerYes
user_idstringYes
external_idstring | nullYes
statusenumYesValues: "active", "waiting", "completed", "exited", "failed"
current_node_idstring | nullYes
next_action_atstring | nullYes
entered_atstringYes
completed_atstring | nullYes
exit_reasonstring | nullYes
goal_idstring | nullYes
goal_reached_atstring | nullYes
contextmap<string, any>Yes
journey_namestringYes
stepsarray<object>Yes
steps[].idstringYes
steps[].node_idstringYes
steps[].node_typestringYes
steps[].statusenumYesValues: "completed", "waiting", "failed", "skipped"
steps[].branchstring | nullYes
steps[].resultmap<string, any>Yes
steps[].started_atstringYes
steps[].finished_atstring | nullYes

Example response:

{
  "status": "active",
  "id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "journey_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "version": 1,
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42",
  "current_node_id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "next_action_at": "örnek",
  "entered_at": "örnek",
  "completed_at": "örnek",
  "exit_reason": "örnek",
  "goal_id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "goal_reached_at": "örnek",
  "context": {
    "key": "örnek"
  },
  "journey_name": "örnek",
  "steps": [
    {
      "status": "completed",
      "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "node_type": "örnek",
      "branch": "örnek",
      "result": {
        "key": "örnek"
      },
      "started_at": "örnek",
      "finished_at": "örnek"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W/runs/run_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Terminate the run

DELETE/v1/apps/{appId}/journeys/{journeyId}/runs/{runId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
journeyIdpathstringYes"jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W"
runIdpathstringYes"run_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: JourneyRunDetail

FieldTypeRequiredDescription
idstringYes
journey_idstringYes
versionintegerYes
user_idstringYes
external_idstring | nullYes
statusenumYesValues: "active", "waiting", "completed", "exited", "failed"
current_node_idstring | nullYes
next_action_atstring | nullYes
entered_atstringYes
completed_atstring | nullYes
exit_reasonstring | nullYes
goal_idstring | nullYes
goal_reached_atstring | nullYes
contextmap<string, any>Yes
journey_namestringYes
stepsarray<object>Yes
steps[].idstringYes
steps[].node_idstringYes
steps[].node_typestringYes
steps[].statusenumYesValues: "completed", "waiting", "failed", "skipped"
steps[].branchstring | nullYes
steps[].resultmap<string, any>Yes
steps[].started_atstringYes
steps[].finished_atstring | nullYes

Example response:

{
  "status": "active",
  "id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "journey_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "version": 1,
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42",
  "current_node_id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "next_action_at": "örnek",
  "entered_at": "örnek",
  "completed_at": "örnek",
  "exit_reason": "örnek",
  "goal_id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "goal_reached_at": "örnek",
  "context": {
    "key": "örnek"
  },
  "journey_name": "örnek",
  "steps": [
    {
      "status": "completed",
      "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "node_type": "örnek",
      "branch": "örnek",
      "result": {
        "key": "örnek"
      },
      "started_at": "örnek",
      "finished_at": "örnek"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/journeys/jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W/runs/run_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Journey runs of the user

GET/v1/apps/{appId}/users/by/{label}/{value}/journeysTry it (interactive API docs, new tab)

Authentication: API key — scope users:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: UserJourneyRuns

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].journey_idstringYes
data[].versionintegerYes
data[].user_idstringYes
data[].external_idstring | nullYes
data[].statusenumYesValues: "active", "waiting", "completed", "exited", "failed"
data[].current_node_idstring | nullYes
data[].next_action_atstring | nullYes
data[].entered_atstringYes
data[].completed_atstring | nullYes
data[].exit_reasonstring | nullYes
data[].goal_idstring | nullYes
data[].goal_reached_atstring | nullYes
data[].contextmap<string, any>Yes
data[].journey_namestringYes

Example response:

{
  "data": [
    {
      "status": "active",
      "id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "journey_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "version": 1,
      "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "external_id": "user_42",
      "current_node_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "next_action_at": "örnek",
      "entered_at": "örnek",
      "completed_at": "örnek",
      "exit_reason": "örnek",
      "goal_id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "goal_reached_at": "örnek",
      "context": {
        "key": "örnek"
      },
      "journey_name": "örnek"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/by/external_id/user_42/journeys" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

On this page