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
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/journeys | List journeys |
POST | /v1/apps/{appId}/journeys | Create 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}/draft | Save the draft |
PATCH | /v1/apps/{appId}/journeys/{journeyId}/nodes/{nodeId} | Update a node in the draft |
GET | /v1/apps/{appId}/journeys/{journeyId}/versions | Versions |
POST | /v1/apps/{appId}/journeys/{journeyId}/versions/{version}/restore | Restore an old version as a new draft (the published version does not change) |
POST | /v1/apps/{appId}/journeys/{journeyId}/publish | Publish |
POST | /v1/apps/{appId}/journeys/{journeyId}/pause | Pause |
POST | /v1/apps/{appId}/journeys/{journeyId}/resume | Resume |
POST | /v1/apps/{appId}/journeys/{journeyId}/archive | Archive |
POST | /v1/apps/{appId}/journeys/{journeyId}/duplicate | Copy |
GET | /v1/apps/{appId}/journeys/{journeyId}/stats | Per-node statistics |
GET | /v1/apps/{appId}/journeys/{journeyId}/runs | List runs |
POST | /v1/apps/{appId}/journeys/{journeyId}/runs | Enter 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}/journeys | Journey runs of the user |
Details
List journeys
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
status | query | enum | No | Values: "draft", "active", "paused", "archived" | "draft" |
q | query | string | No | Length: 0–100 | "ayse" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: JourneyPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].status | enum | Yes | Values: "draft", "active", "paused", "archived" |
data[].current_version | integer | null | Yes | |
data[].draft_version | integer | null | Yes | |
data[].trigger_kind | string | null | Yes | |
data[].published_at | string | null | Yes | |
data[].created_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
data[].summary | object | Yes | |
data[].summary.runs_total | integer | Yes | |
data[].summary.active | integer | Yes | |
data[].summary.completed | integer | Yes | |
data[].summary.exited | integer | Yes | |
data[].summary.failed | integer | Yes | |
data[].summary.goal_reached | integer | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
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)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–120 |
description | string | No | Length: 0–500 |
graph | object | No | React Flow compatible journey graph: { nodes: [{ id, type, position, data }], edges: [{ id, source, target, sourceHandle }] } (docs/journeys.md) |
graph.nodes | array<object> | Yes | |
graph.edges | array<object> | Yes | |
settings | object | No | Re-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
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
current_version | integer | null | Yes | |
draft_version | integer | null | Yes | |
trigger_kind | string | null | Yes | |
published_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes | |
editing | object | Yes | |
editing.version | integer | Yes | |
editing.graph | map<string, any> | Yes | |
editing.settings | map<string, any> | Yes | |
editing.published_at | string | null | Yes | |
editing.published_by | string | null | Yes | |
editing.created_at | string | Yes | |
editing.updated_at | string | Yes | |
issues | array<object> | Yes | |
issues[].code | string | Yes | |
issues[].node_id | string | No | |
issues[].edge_id | string | No | |
issues[].message | string | Yes |
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
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: JourneyDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
current_version | integer | null | Yes | |
draft_version | integer | null | Yes | |
trigger_kind | string | null | Yes | |
published_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes | |
editing | object | Yes | |
editing.version | integer | Yes | |
editing.graph | map<string, any> | Yes | |
editing.settings | map<string, any> | Yes | |
editing.published_at | string | null | Yes | |
editing.published_by | string | null | Yes | |
editing.created_at | string | Yes | |
editing.updated_at | string | Yes | |
issues | array<object> | Yes | |
issues[].code | string | Yes | |
issues[].node_id | string | No | |
issues[].edge_id | string | No | |
issues[].message | string | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateJourneyDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–120 |
description | string | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri"
}Responses
200 — Success.
Schema: JourneyDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
current_version | integer | null | Yes | |
draft_version | integer | null | Yes | |
trigger_kind | string | null | Yes | |
published_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes | |
editing | object | Yes | |
editing.version | integer | Yes | |
editing.graph | map<string, any> | Yes | |
editing.settings | map<string, any> | Yes | |
editing.published_at | string | null | Yes | |
editing.published_by | string | null | Yes | |
editing.created_at | string | Yes | |
editing.updated_at | string | Yes | |
issues | array<object> | Yes | |
issues[].code | string | Yes | |
issues[].node_id | string | No | |
issues[].edge_id | string | No | |
issues[].message | string | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
| Field | Type | Required | Description |
|---|---|---|---|
graph | object | Yes | React Flow compatible journey graph: { nodes: [{ id, type, position, data }], edges: [{ id, source, target, sourceHandle }] } (docs/journeys.md) |
graph.nodes | array<object> | Yes | |
graph.edges | array<object> | Yes | |
settings | object | No | Re-entry, new entrants only, exit rules, exit tags, goals, schedule (docs/journeys.md) |
Example:
{
"graph": {
"nodes": [
{}
],
"edges": [
{}
]
},
"settings": {}
}Responses
200 — Success.
Schema: JourneyDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
current_version | integer | null | Yes | |
draft_version | integer | null | Yes | |
trigger_kind | string | null | Yes | |
published_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes | |
editing | object | Yes | |
editing.version | integer | Yes | |
editing.graph | map<string, any> | Yes | |
editing.settings | map<string, any> | Yes | |
editing.published_at | string | null | Yes | |
editing.published_by | string | null | Yes | |
editing.created_at | string | Yes | |
editing.updated_at | string | Yes | |
issues | array<object> | Yes | |
issues[].code | string | Yes | |
issues[].node_id | string | No | |
issues[].edge_id | string | No | |
issues[].message | string | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
nodeId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateNodeDto
| Field | Type | Required | Description |
|---|---|---|---|
data | map<string, any> | No | |
position | object | No | |
position.x | number | Yes | |
position.y | number | Yes |
Example:
{
"data": {
"order_id": "1001"
},
"position": {
"x": 1.5,
"y": 1.5
}
}Responses
200 — Success.
Schema: JourneyDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
current_version | integer | null | Yes | |
draft_version | integer | null | Yes | |
trigger_kind | string | null | Yes | |
published_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes | |
editing | object | Yes | |
editing.version | integer | Yes | |
editing.graph | map<string, any> | Yes | |
editing.settings | map<string, any> | Yes | |
editing.published_at | string | null | Yes | |
editing.published_by | string | null | Yes | |
editing.created_at | string | Yes | |
editing.updated_at | string | Yes | |
issues | array<object> | Yes | |
issues[].code | string | Yes | |
issues[].node_id | string | No | |
issues[].edge_id | string | No | |
issues[].message | string | Yes |
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
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: JourneyVersionList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].version | integer | Yes | |
data[].graph | map<string, any> | Yes | |
data[].settings | map<string, any> | Yes | |
data[].published_at | string | null | Yes | |
data[].published_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
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)
/v1/apps/{appId}/journeys/{journeyId}/versions/{version}/restoreTry it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
version | path | number | Yes | 1.5 | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: JourneyDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
current_version | integer | null | Yes | |
draft_version | integer | null | Yes | |
trigger_kind | string | null | Yes | |
published_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes | |
editing | object | Yes | |
editing.version | integer | Yes | |
editing.graph | map<string, any> | Yes | |
editing.settings | map<string, any> | Yes | |
editing.published_at | string | null | Yes | |
editing.published_by | string | null | Yes | |
editing.created_at | string | Yes | |
editing.updated_at | string | Yes | |
issues | array<object> | Yes | |
issues[].code | string | Yes | |
issues[].node_id | string | No | |
issues[].edge_id | string | No | |
issues[].message | string | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: JourneyPublishResult
| Field | Type | Required | Description |
|---|---|---|---|
journey | object | Yes | |
journey.id | string | Yes | |
journey.app_id | string | Yes | |
journey.name | string | Yes | |
journey.description | string | null | Yes | |
journey.status | enum | Yes | Values: "draft", "active", "paused", "archived" |
journey.current_version | integer | null | Yes | |
journey.draft_version | integer | null | Yes | |
journey.trigger_kind | string | null | Yes | |
journey.published_at | string | null | Yes | |
journey.created_by | string | null | Yes | |
journey.created_at | string | Yes | |
journey.updated_at | string | Yes | |
journey.summary | object | Yes | |
journey.summary.runs_total | integer | Yes | |
journey.summary.active | integer | Yes | |
journey.summary.completed | integer | Yes | |
journey.summary.exited | integer | Yes | |
journey.summary.failed | integer | Yes | |
journey.summary.goal_reached | integer | Yes | |
version | integer | Yes | |
issues | array<object> | Yes | |
issues[].code | string | Yes | |
issues[].node_id | string | No | |
issues[].edge_id | string | No | |
issues[].message | string | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: JourneyDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
current_version | integer | null | Yes | |
draft_version | integer | null | Yes | |
trigger_kind | string | null | Yes | |
published_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes | |
editing | object | Yes | |
editing.version | integer | Yes | |
editing.graph | map<string, any> | Yes | |
editing.settings | map<string, any> | Yes | |
editing.published_at | string | null | Yes | |
editing.published_by | string | null | Yes | |
editing.created_at | string | Yes | |
editing.updated_at | string | Yes | |
issues | array<object> | Yes | |
issues[].code | string | Yes | |
issues[].node_id | string | No | |
issues[].edge_id | string | No | |
issues[].message | string | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: JourneyDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
current_version | integer | null | Yes | |
draft_version | integer | null | Yes | |
trigger_kind | string | null | Yes | |
published_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes | |
editing | object | Yes | |
editing.version | integer | Yes | |
editing.graph | map<string, any> | Yes | |
editing.settings | map<string, any> | Yes | |
editing.published_at | string | null | Yes | |
editing.published_by | string | null | Yes | |
editing.created_at | string | Yes | |
editing.updated_at | string | Yes | |
issues | array<object> | Yes | |
issues[].code | string | Yes | |
issues[].node_id | string | No | |
issues[].edge_id | string | No | |
issues[].message | string | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: JourneyDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
current_version | integer | null | Yes | |
draft_version | integer | null | Yes | |
trigger_kind | string | null | Yes | |
published_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes | |
editing | object | Yes | |
editing.version | integer | Yes | |
editing.graph | map<string, any> | Yes | |
editing.settings | map<string, any> | Yes | |
editing.published_at | string | null | Yes | |
editing.published_by | string | null | Yes | |
editing.created_at | string | Yes | |
editing.updated_at | string | Yes | |
issues | array<object> | Yes | |
issues[].code | string | Yes | |
issues[].node_id | string | No | |
issues[].edge_id | string | No | |
issues[].message | string | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
201 — Success.
Schema: JourneyDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
current_version | integer | null | Yes | |
draft_version | integer | null | Yes | |
trigger_kind | string | null | Yes | |
published_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes | |
editing | object | Yes | |
editing.version | integer | Yes | |
editing.graph | map<string, any> | Yes | |
editing.settings | map<string, any> | Yes | |
editing.published_at | string | null | Yes | |
editing.published_by | string | null | Yes | |
editing.created_at | string | Yes | |
editing.updated_at | string | Yes | |
issues | array<object> | Yes | |
issues[].code | string | Yes | |
issues[].node_id | string | No | |
issues[].edge_id | string | No | |
issues[].message | string | Yes |
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
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
version | query | integer | No | Range: 1–∞ | 1 |
all_versions | query | enum | No | Values: "true", "false" | "true" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: JourneyStats
| Field | Type | Required | Description |
|---|---|---|---|
version | integer | null | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes | |
summary.waiting | integer | Yes | |
summary.goal_conversion_rate | number | Yes | |
nodes | array<object> | Yes | |
nodes[].node_id | string | Yes | |
nodes[].node_type | string | Yes | |
nodes[].entered | integer | Yes | |
nodes[].completed | integer | Yes | |
nodes[].waiting_now | integer | Yes | |
nodes[].skipped | integer | Yes | |
nodes[].failed | integer | Yes | |
nodes[].branches | map<string, integer> | Yes | |
nodes[].messages | map<string, integer> | No | |
nodes[].variants | array<object> | No | |
nodes[].variants[].variant_id | string | Yes | |
nodes[].variants[].sent | integer | Yes | |
nodes[].variants[].opened | integer | Yes | |
nodes[].variants[].clicked | integer | Yes | |
nodes[].variants[].converted | integer | Yes | |
nodes[].variants[].winner | boolean | Yes | |
goals | array<object> | Yes | |
goals[].goal_id | string | Yes | |
goals[].reached | integer | Yes | |
exit_reasons | map<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
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
status | query | enum | No | Values: "active", "waiting", "completed", "exited", "failed" | "active" |
user_id | query | string | No | Length: 0–64 | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
version | query | integer | No | Range: 1–∞ | 1 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: JourneyRunPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].journey_id | string | Yes | |
data[].version | integer | Yes | |
data[].user_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].status | enum | Yes | Values: "active", "waiting", "completed", "exited", "failed" |
data[].current_node_id | string | null | Yes | |
data[].next_action_at | string | null | Yes | |
data[].entered_at | string | Yes | |
data[].completed_at | string | null | Yes | |
data[].exit_reason | string | null | Yes | |
data[].goal_id | string | null | Yes | |
data[].goal_reached_at | string | null | Yes | |
data[].context | map<string, any> | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
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)
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: TriggerRunDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | No | Length: 1–255 |
user_id | string | No | Length: 1–64 |
alias | object | No | |
alias.label | string | Yes | Length: 1–50 |
alias.value | string | Yes | Length: 1–255 |
context | map<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
| Field | Type | Required | Description |
|---|---|---|---|
entered | boolean | Yes | |
run | object | null | Yes | |
reason | enum | null | Yes |
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
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
runId | path | string | Yes | "run_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: JourneyRunDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
journey_id | string | Yes | |
version | integer | Yes | |
user_id | string | Yes | |
external_id | string | null | Yes | |
status | enum | Yes | Values: "active", "waiting", "completed", "exited", "failed" |
current_node_id | string | null | Yes | |
next_action_at | string | null | Yes | |
entered_at | string | Yes | |
completed_at | string | null | Yes | |
exit_reason | string | null | Yes | |
goal_id | string | null | Yes | |
goal_reached_at | string | null | Yes | |
context | map<string, any> | Yes | |
journey_name | string | Yes | |
steps | array<object> | Yes | |
steps[].id | string | Yes | |
steps[].node_id | string | Yes | |
steps[].node_type | string | Yes | |
steps[].status | enum | Yes | Values: "completed", "waiting", "failed", "skipped" |
steps[].branch | string | null | Yes | |
steps[].result | map<string, any> | Yes | |
steps[].started_at | string | Yes | |
steps[].finished_at | string | null | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
journeyId | path | string | Yes | "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
runId | path | string | Yes | "run_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: JourneyRunDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
journey_id | string | Yes | |
version | integer | Yes | |
user_id | string | Yes | |
external_id | string | null | Yes | |
status | enum | Yes | Values: "active", "waiting", "completed", "exited", "failed" |
current_node_id | string | null | Yes | |
next_action_at | string | null | Yes | |
entered_at | string | Yes | |
completed_at | string | null | Yes | |
exit_reason | string | null | Yes | |
goal_id | string | null | Yes | |
goal_reached_at | string | null | Yes | |
context | map<string, any> | Yes | |
journey_name | string | Yes | |
steps | array<object> | Yes | |
steps[].id | string | Yes | |
steps[].node_id | string | Yes | |
steps[].node_type | string | Yes | |
steps[].status | enum | Yes | Values: "completed", "waiting", "failed", "skipped" |
steps[].branch | string | null | Yes | |
steps[].result | map<string, any> | Yes | |
steps[].started_at | string | Yes | |
steps[].finished_at | string | null | Yes |
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
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
label | path | string | Yes | "external_id" | |
value | path | string | Yes | "user_42" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: UserJourneyRuns
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].journey_id | string | Yes | |
data[].version | integer | Yes | |
data[].user_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].status | enum | Yes | Values: "active", "waiting", "completed", "exited", "failed" |
data[].current_node_id | string | null | Yes | |
data[].next_action_at | string | null | Yes | |
data[].entered_at | string | Yes | |
data[].completed_at | string | null | Yes | |
data[].exit_reason | string | null | Yes | |
data[].goal_id | string | null | Yes | |
data[].goal_reached_at | string | null | Yes | |
data[].context | map<string, any> | Yes | |
data[].journey_name | string | Yes |
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"Campaigns
Campaigns — 28 operations (GET /v1/apps/{appId}/custom-agents, POST /v1/apps/{appId}/custom-agents, GET /v1/apps/{appId}/custom-agents/runs, …). Generated from the OpenAPI 3.1.0 contract.
In-app messages
In-app messages — 7 operations (GET /v1/apps/{appId}/in-app-messages, POST /v1/apps/{appId}/in-app-messages, GET /v1/apps/{appId}/in-app-messages/{messageId}, …). Generated from the OpenAPI 3.1.0 contract.