Integrations
Integrations — 26 operations (GET /v1/apps/{appId}/data-pipelines/transforms, POST /v1/apps/{appId}/data-pipelines/transforms, POST /v1/apps/{appId}/data-pipelines/transforms/preview, …). Generated from the OpenAPI 3.1.0 contract.
Built-in integrations: Zapier trigger subscriptions and analytics destinations (Segment, Amplitude, Mixpanel).
Base URL: https://api.pushizo.com · Tag: integrations · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/data-pipelines/transforms | Data transformations |
POST | /v1/apps/{appId}/data-pipelines/transforms | Create a data transformation |
POST | /v1/apps/{appId}/data-pipelines/transforms/preview | Transformation preview (dry run with sample records) |
GET | /v1/apps/{appId}/data-pipelines/transforms/{transformId} | Data transformation |
PATCH | /v1/apps/{appId}/data-pipelines/transforms/{transformId} | Update a data transformation |
DELETE | /v1/apps/{appId}/data-pipelines/transforms/{transformId} | Delete a data transformation |
GET | /v1/apps/{appId}/data-pipelines/sources | Data sources (webhook and HTTP pull) |
POST | /v1/apps/{appId}/data-pipelines/sources | Create a data source |
GET | /v1/apps/{appId}/data-pipelines/sources/{sourceId} | Data source |
PATCH | /v1/apps/{appId}/data-pipelines/sources/{sourceId} | Update a data source |
DELETE | /v1/apps/{appId}/data-pipelines/sources/{sourceId} | Delete a data source |
POST | /v1/apps/{appId}/data-pipelines/sources/{sourceId}/rotate-secret | Rotate the webhook source key |
POST | /v1/apps/{appId}/data-pipelines/sources/{sourceId}/run | Run the HTTP pull source now |
GET | /v1/apps/{appId}/data-pipelines/quarantine | Quarantined records |
POST | /v1/apps/{appId}/data-pipelines/quarantine/reprocess | Reprocess quarantined records |
POST | /v1/apps/{appId}/data-pipelines/quarantine/discard | Discard quarantined records without reprocessing |
GET | /v1/apps/{appId}/integrations/zapier/me | Zapier connection test: the key's app and scopes |
GET | /v1/apps/{appId}/integrations/zapier/hooks | Zapier REST Hook subscriptions |
POST | /v1/apps/{appId}/integrations/zapier/hooks | REST Hook subscription (Zap turned on) |
DELETE | /v1/apps/{appId}/integrations/zapier/hooks/{hookId} | Delete a REST Hook subscription (Zap turned off) |
GET | /v1/apps/{appId}/integrations/zapier/samples | Trigger samples (performList): recent records, in the same format as the subscription body |
GET | /v1/apps/{appId}/integrations | Connected integrations and the catalog |
GET | /v1/apps/{appId}/integrations/{type} | Integration details (credentials masked) |
GET | /v1/apps/{appId}/integrations/{type}/runs | Recent runs (sync, event export, inbound requests, tests) |
POST | /v1/apps/{appId}/integrations/{type}/test | Connection test |
POST | /v1/apps/{appId}/integrations/{type}/sync | Run the cohort sync now (the worker picks it up within 1 minute) |
Details
Data transformations
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
target | query | enum | No | Values: "event", "person" | "event" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: DataTransformList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | Yes | |
data[].enabled | boolean | Yes | |
data[].target | enum | Yes | Values: "event", "person" |
data[].kind | enum | Yes | Values: "rules", "javascript" |
data[].position | integer | Yes | |
data[].sources | array<enum> | Yes | |
data[].event_names | array<string> | Yes | |
data[].rules | array<map<string, any>> | Yes | |
data[].code | string | null | Yes | |
data[].error_count | integer | Yes | |
data[].last_error_code | enum | null | Yes | |
data[].last_error_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"target": "event",
"enabled": true,
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"kind": "rules",
"position": 1,
"sources": [
"sdk"
],
"event_names": [
"purchase"
],
"rules": [
{
"key": "örnek"
}
],
"code": "örnek",
"error_count": 1,
"last_error_code": "mapping_failed",
"last_error_at": "ö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/data-pipelines/transforms" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a data transformation
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)
Schema: CreateDataTransformDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–80 |
description | string | No | Length: 0–500 |
enabled | boolean | No | |
target | enum | Yes | Values: "event", "person" |
kind | enum | Yes | Values: "rules", "javascript" |
position | integer | No | Range: 0–10000 |
rules | array<object> | No | Items: 0–50 |
code | string | No | Length: 0–20000 |
sources | array<enum> | No | Items: 0–6 |
event_names | array<string> | No | Items: 0–50 |
Example:
{
"name": "Sipariş bildirimleri",
"target": "event",
"kind": "rules",
"enabled": true,
"description": "Sipariş durumu güncellemeleri",
"position": 1,
"rules": [
{
"op": "map",
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z"
}
],
"code": "örnek"
}Responses
201 — Success.
Schema: DataTransform
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | Yes | |
enabled | boolean | Yes | |
target | enum | Yes | Values: "event", "person" |
kind | enum | Yes | Values: "rules", "javascript" |
position | integer | Yes | |
sources | array<enum> | Yes | |
event_names | array<string> | Yes | |
rules | array<map<string, any>> | Yes | |
code | string | null | Yes | |
error_count | integer | Yes | |
last_error_code | enum | null | Yes | |
last_error_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"target": "event",
"enabled": true,
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"kind": "rules",
"position": 1,
"sources": [
"sdk"
],
"event_names": [
"purchase"
],
"rules": [
{
"key": "örnek"
}
],
"code": "örnek",
"error_count": 1,
"last_error_code": "mapping_failed",
"last_error_at": "ö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 POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/data-pipelines/transforms" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"target": "event",
"kind": "rules",
"enabled": true,
"description": "Sipariş durumu güncellemeleri",
"position": 1,
"rules": [
{
"op": "map",
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z"
}
],
"code": "örnek"
}'Transformation preview (dry run with sample records)
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)
Schema: PreviewDataTransformDto
| Field | Type | Required | Description |
|---|---|---|---|
target | enum | Yes | Values: "event", "person" |
source | enum | No | Values: "sdk", "api", "import", "system", "webhook_source", "pull_source" |
records | array<map<string, any>> | Yes | Items: 1–20 |
transform | object | No | |
transform.kind | enum | Yes | Values: "rules", "javascript" |
transform.rules | array<object> | No | Items: 0–50 |
transform.code | string | No | Length: 0–20000 |
transform.sources | array<enum> | No | Items: 0–6 |
transform.event_names | array<string> | No | Items: 0–50 |
transform_id | string | No |
Example:
{
"target": "event",
"records": [
{
"key": "örnek"
}
],
"source": "sdk",
"transform": {
"kind": "rules",
"rules": [
{
"op": "map",
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z"
}
],
"code": "örnek",
"sources": [
"sdk"
]
},
"transform_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}Responses
200 — Success.
Schema: DataTransformPreview
| Field | Type | Required | Description |
|---|---|---|---|
results | array<object> | Yes | |
results[].status | enum | Yes | Values: "kept", "dropped", "failed" |
results[].record | map<string, any> | null | Yes | |
results[].transform_id | string | null | Yes | |
results[].error_code | enum | null | Yes | |
results[].error_path | string | null | Yes | |
results[].error_message | string | null | Yes | |
results[].logs | array<string> | Yes | |
duration_ms | integer | Yes |
Example response:
{
"results": [
{
"status": "kept",
"record": {
"key": "örnek"
},
"transform_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"error_code": "mapping_failed",
"error_path": "örnek",
"error_message": "örnek",
"logs": [
"örnek"
]
}
],
"duration_ms": 1
}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/data-pipelines/transforms/preview" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"target": "event",
"records": [
{
"key": "örnek"
}
],
"source": "sdk",
"transform": {
"kind": "rules",
"rules": [
{
"op": "map",
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z"
}
],
"code": "örnek",
"sources": [
"sdk"
]
},
"transform_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'Data transformation
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
transformId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: DataTransform
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | Yes | |
enabled | boolean | Yes | |
target | enum | Yes | Values: "event", "person" |
kind | enum | Yes | Values: "rules", "javascript" |
position | integer | Yes | |
sources | array<enum> | Yes | |
event_names | array<string> | Yes | |
rules | array<map<string, any>> | Yes | |
code | string | null | Yes | |
error_count | integer | Yes | |
last_error_code | enum | null | Yes | |
last_error_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"target": "event",
"enabled": true,
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"kind": "rules",
"position": 1,
"sources": [
"sdk"
],
"event_names": [
"purchase"
],
"rules": [
{
"key": "örnek"
}
],
"code": "örnek",
"error_count": 1,
"last_error_code": "mapping_failed",
"last_error_at": "ö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/data-pipelines/transforms/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a data transformation
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
transformId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateDataTransformDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–80 |
description | string | No | Length: 0–500 |
enabled | boolean | No | |
position | integer | No | Range: 0–10000 |
rules | array<object> | No | Items: 0–50 |
code | string | No | Length: 0–20000 |
sources | array<enum> | No | Items: 0–6 |
event_names | array<string> | No | Items: 0–50 |
Example:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"description": "Sipariş durumu güncellemeleri",
"position": 1,
"rules": [
{
"op": "map",
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z"
}
]
}Responses
200 — Success.
Schema: DataTransform
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | Yes | |
enabled | boolean | Yes | |
target | enum | Yes | Values: "event", "person" |
kind | enum | Yes | Values: "rules", "javascript" |
position | integer | Yes | |
sources | array<enum> | Yes | |
event_names | array<string> | Yes | |
rules | array<map<string, any>> | Yes | |
code | string | null | Yes | |
error_count | integer | Yes | |
last_error_code | enum | null | Yes | |
last_error_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"target": "event",
"enabled": true,
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"kind": "rules",
"position": 1,
"sources": [
"sdk"
],
"event_names": [
"purchase"
],
"rules": [
{
"key": "örnek"
}
],
"code": "örnek",
"error_count": 1,
"last_error_code": "mapping_failed",
"last_error_at": "ö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 PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/data-pipelines/transforms/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"enabled": true,
"description": "Sipariş durumu güncellemeleri",
"position": 1,
"rules": [
{
"op": "map",
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z"
}
]
}'Delete a data transformation
/v1/apps/{appId}/data-pipelines/transforms/{transformId}Try it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
transformId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
204 — Success.
No body.
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/data-pipelines/transforms/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Data sources (webhook and HTTP pull)
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: DataSourceList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].kind | enum | Yes | Values: "webhook", "http_pull" |
data[].target | enum | Yes | Values: "event", "person" |
data[].enabled | boolean | Yes | |
data[].auth_mode | enum | Yes | Values: "signature", "token" |
data[].mapping | object | Yes | |
data[].mapping.records_path | string | No | Length: 1–200 |
data[].mapping.event_name | string | No | Length: 1–100 |
data[].mapping.event_name_path | string | No | Length: 1–200 |
data[].mapping.external_id_path | string | No | Length: 1–200 |
data[].mapping.occurred_at_path | string | No | Length: 1–200 |
data[].mapping.value_path | string | No | Length: 1–200 |
data[].mapping.event_id_path | string | No | Length: 1–200 |
data[].mapping.properties_path | string | No | Length: 1–200 |
data[].mapping.tags_path | string | No | Length: 1–200 |
data[].config | object | Yes | |
data[].config.url | string (uri) | No | Length: 0–2000 |
data[].config.method | enum | No | Values: "GET", "POST" |
data[].config.headers | map<string, string> | No | |
data[].config.body | string | No | Length: 0–10000 |
data[].config.interval_minutes | integer | No | Range: 5–1440 |
data[].config.auth_header | string | No | |
data[].config.next_cursor_path | string | No | Length: 1–200 |
data[].config.cursor_param | string | No | |
data[].config.resume_cursor | boolean | No | |
data[].has_secret | boolean | Yes | |
data[].webhook_url | string | null | Yes | |
data[].next_run_at | string | null | Yes | |
data[].last_run_at | string | null | Yes | |
data[].last_status | string | null | Yes | |
data[].last_error | string | null | Yes | |
data[].last_stats | map<string, number> | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"target": "event",
"enabled": true,
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"kind": "webhook",
"auth_mode": "signature",
"mapping": {
"records_path": "örnek",
"event_name": "purchase"
},
"config": {
"url": "https://pushizo.com/orders/1001",
"method": "GET"
},
"has_secret": true,
"webhook_url": "https://pushizo.com/orders/1001",
"next_run_at": "örnek",
"last_run_at": "örnek",
"last_status": "örnek",
"last_error": "örnek",
"last_stats": {
"key": 149.9
},
"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/data-pipelines/sources" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a data source
The webhook source's signing/access key is returned only in this response.
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)
Schema: CreateDataSourceDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–80 |
enabled | boolean | No | |
auth_mode | enum | No | Values: "signature", "token" |
mapping | object | No | |
mapping.records_path | string | No | Length: 1–200 |
mapping.event_name | string | No | Length: 1–100 |
mapping.event_name_path | string | No | Length: 1–200 |
mapping.external_id_path | string | No | Length: 1–200 |
mapping.occurred_at_path | string | No | Length: 1–200 |
mapping.value_path | string | No | Length: 1–200 |
mapping.event_id_path | string | No | Length: 1–200 |
mapping.properties_path | string | No | Length: 1–200 |
mapping.tags_path | string | No | Length: 1–200 |
config | object | No | |
config.url | string (uri) | No | Length: 0–2000 |
config.method | enum | No | Values: "GET", "POST" |
config.headers | map<string, string> | No | |
config.body | string | No | Length: 0–10000 |
config.interval_minutes | integer | No | Range: 5–1440 |
config.auth_header | string | No | |
config.next_cursor_path | string | No | Length: 1–200 |
config.cursor_param | string | No | |
config.resume_cursor | boolean | No | |
auth_value | string | No | Length: 0–2000 |
kind | enum | Yes | Values: "webhook", "http_pull" |
target | enum | Yes | Values: "event", "person" |
Example:
{
"name": "Sipariş bildirimleri",
"target": "event",
"kind": "webhook",
"enabled": true,
"auth_mode": "signature",
"mapping": {
"records_path": "örnek",
"event_name": "purchase",
"event_name_path": "örnek"
},
"config": {
"url": "https://pushizo.com/orders/1001",
"method": "GET",
"headers": {
"key": "user_42"
}
},
"auth_value": "örnek"
}Responses
201 — Success.
Schema: DataSourceWithSecret
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "webhook", "http_pull" |
target | enum | Yes | Values: "event", "person" |
enabled | boolean | Yes | |
auth_mode | enum | Yes | Values: "signature", "token" |
mapping | object | Yes | |
mapping.records_path | string | No | Length: 1–200 |
mapping.event_name | string | No | Length: 1–100 |
mapping.event_name_path | string | No | Length: 1–200 |
mapping.external_id_path | string | No | Length: 1–200 |
mapping.occurred_at_path | string | No | Length: 1–200 |
mapping.value_path | string | No | Length: 1–200 |
mapping.event_id_path | string | No | Length: 1–200 |
mapping.properties_path | string | No | Length: 1–200 |
mapping.tags_path | string | No | Length: 1–200 |
config | object | Yes | |
config.url | string (uri) | No | Length: 0–2000 |
config.method | enum | No | Values: "GET", "POST" |
config.headers | map<string, string> | No | |
config.body | string | No | Length: 0–10000 |
config.interval_minutes | integer | No | Range: 5–1440 |
config.auth_header | string | No | |
config.next_cursor_path | string | No | Length: 1–200 |
config.cursor_param | string | No | |
config.resume_cursor | boolean | No | |
has_secret | boolean | Yes | |
webhook_url | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
last_status | string | null | Yes | |
last_error | string | null | Yes | |
last_stats | map<string, number> | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
secret | string | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"target": "event",
"enabled": true,
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"kind": "webhook",
"auth_mode": "signature",
"mapping": {
"records_path": "örnek",
"event_name": "purchase",
"event_name_path": "örnek",
"external_id_path": "örnek"
},
"config": {
"url": "https://pushizo.com/orders/1001",
"method": "GET",
"headers": {
"key": "user_42"
},
"body": "Takip bağlantısı içeride"
},
"has_secret": true,
"webhook_url": "https://pushizo.com/orders/1001",
"next_run_at": "örnek",
"last_run_at": "örnek",
"last_status": "örnek",
"last_error": "örnek",
"last_stats": {
"key": 149.9
},
"created_at": "örnek",
"updated_at": "örnek",
"secret": "ö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 POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/data-pipelines/sources" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"target": "event",
"kind": "webhook",
"enabled": true,
"auth_mode": "signature",
"mapping": {
"records_path": "örnek",
"event_name": "purchase",
"event_name_path": "örnek"
},
"config": {
"url": "https://pushizo.com/orders/1001",
"method": "GET",
"headers": {
"key": "user_42"
}
},
"auth_value": "örnek"
}'Data source
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
sourceId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: DataSource
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "webhook", "http_pull" |
target | enum | Yes | Values: "event", "person" |
enabled | boolean | Yes | |
auth_mode | enum | Yes | Values: "signature", "token" |
mapping | object | Yes | |
mapping.records_path | string | No | Length: 1–200 |
mapping.event_name | string | No | Length: 1–100 |
mapping.event_name_path | string | No | Length: 1–200 |
mapping.external_id_path | string | No | Length: 1–200 |
mapping.occurred_at_path | string | No | Length: 1–200 |
mapping.value_path | string | No | Length: 1–200 |
mapping.event_id_path | string | No | Length: 1–200 |
mapping.properties_path | string | No | Length: 1–200 |
mapping.tags_path | string | No | Length: 1–200 |
config | object | Yes | |
config.url | string (uri) | No | Length: 0–2000 |
config.method | enum | No | Values: "GET", "POST" |
config.headers | map<string, string> | No | |
config.body | string | No | Length: 0–10000 |
config.interval_minutes | integer | No | Range: 5–1440 |
config.auth_header | string | No | |
config.next_cursor_path | string | No | Length: 1–200 |
config.cursor_param | string | No | |
config.resume_cursor | boolean | No | |
has_secret | boolean | Yes | |
webhook_url | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
last_status | string | null | Yes | |
last_error | string | null | Yes | |
last_stats | map<string, number> | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"target": "event",
"enabled": true,
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"kind": "webhook",
"auth_mode": "signature",
"mapping": {
"records_path": "örnek",
"event_name": "purchase",
"event_name_path": "örnek",
"external_id_path": "örnek"
},
"config": {
"url": "https://pushizo.com/orders/1001",
"method": "GET",
"headers": {
"key": "user_42"
},
"body": "Takip bağlantısı içeride"
},
"has_secret": true,
"webhook_url": "https://pushizo.com/orders/1001",
"next_run_at": "örnek",
"last_run_at": "örnek",
"last_status": "örnek",
"last_error": "örnek",
"last_stats": {
"key": 149.9
},
"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/data-pipelines/sources/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a data source
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
sourceId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateDataSourceDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–80 |
enabled | boolean | No | |
auth_mode | enum | No | Values: "signature", "token" |
mapping | object | No | |
mapping.records_path | string | No | Length: 1–200 |
mapping.event_name | string | No | Length: 1–100 |
mapping.event_name_path | string | No | Length: 1–200 |
mapping.external_id_path | string | No | Length: 1–200 |
mapping.occurred_at_path | string | No | Length: 1–200 |
mapping.value_path | string | No | Length: 1–200 |
mapping.event_id_path | string | No | Length: 1–200 |
mapping.properties_path | string | No | Length: 1–200 |
mapping.tags_path | string | No | Length: 1–200 |
config | object | No | |
config.url | string (uri) | No | Length: 0–2000 |
config.method | enum | No | Values: "GET", "POST" |
config.headers | map<string, string> | No | |
config.body | string | No | Length: 0–10000 |
config.interval_minutes | integer | No | Range: 5–1440 |
config.auth_header | string | No | |
config.next_cursor_path | string | No | Length: 1–200 |
config.cursor_param | string | No | |
config.resume_cursor | boolean | No | |
auth_value | string | No | Length: 0–2000 |
Example:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"auth_mode": "signature",
"mapping": {
"records_path": "örnek",
"event_name": "purchase",
"event_name_path": "örnek"
},
"config": {
"url": "https://pushizo.com/orders/1001",
"method": "GET",
"headers": {
"key": "user_42"
}
}
}Responses
200 — Success.
Schema: DataSource
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "webhook", "http_pull" |
target | enum | Yes | Values: "event", "person" |
enabled | boolean | Yes | |
auth_mode | enum | Yes | Values: "signature", "token" |
mapping | object | Yes | |
mapping.records_path | string | No | Length: 1–200 |
mapping.event_name | string | No | Length: 1–100 |
mapping.event_name_path | string | No | Length: 1–200 |
mapping.external_id_path | string | No | Length: 1–200 |
mapping.occurred_at_path | string | No | Length: 1–200 |
mapping.value_path | string | No | Length: 1–200 |
mapping.event_id_path | string | No | Length: 1–200 |
mapping.properties_path | string | No | Length: 1–200 |
mapping.tags_path | string | No | Length: 1–200 |
config | object | Yes | |
config.url | string (uri) | No | Length: 0–2000 |
config.method | enum | No | Values: "GET", "POST" |
config.headers | map<string, string> | No | |
config.body | string | No | Length: 0–10000 |
config.interval_minutes | integer | No | Range: 5–1440 |
config.auth_header | string | No | |
config.next_cursor_path | string | No | Length: 1–200 |
config.cursor_param | string | No | |
config.resume_cursor | boolean | No | |
has_secret | boolean | Yes | |
webhook_url | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
last_status | string | null | Yes | |
last_error | string | null | Yes | |
last_stats | map<string, number> | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"target": "event",
"enabled": true,
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"kind": "webhook",
"auth_mode": "signature",
"mapping": {
"records_path": "örnek",
"event_name": "purchase",
"event_name_path": "örnek",
"external_id_path": "örnek"
},
"config": {
"url": "https://pushizo.com/orders/1001",
"method": "GET",
"headers": {
"key": "user_42"
},
"body": "Takip bağlantısı içeride"
},
"has_secret": true,
"webhook_url": "https://pushizo.com/orders/1001",
"next_run_at": "örnek",
"last_run_at": "örnek",
"last_status": "örnek",
"last_error": "örnek",
"last_stats": {
"key": 149.9
},
"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 PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/data-pipelines/sources/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"enabled": true,
"auth_mode": "signature",
"mapping": {
"records_path": "örnek",
"event_name": "purchase",
"event_name_path": "örnek"
},
"config": {
"url": "https://pushizo.com/orders/1001",
"method": "GET",
"headers": {
"key": "user_42"
}
}
}'Delete a data source
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
sourceId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
204 — Success.
No body.
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/data-pipelines/sources/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Rotate the webhook source key
/v1/apps/{appId}/data-pipelines/sources/{sourceId}/rotate-secretTry it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
sourceId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: DataSourceWithSecret
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "webhook", "http_pull" |
target | enum | Yes | Values: "event", "person" |
enabled | boolean | Yes | |
auth_mode | enum | Yes | Values: "signature", "token" |
mapping | object | Yes | |
mapping.records_path | string | No | Length: 1–200 |
mapping.event_name | string | No | Length: 1–100 |
mapping.event_name_path | string | No | Length: 1–200 |
mapping.external_id_path | string | No | Length: 1–200 |
mapping.occurred_at_path | string | No | Length: 1–200 |
mapping.value_path | string | No | Length: 1–200 |
mapping.event_id_path | string | No | Length: 1–200 |
mapping.properties_path | string | No | Length: 1–200 |
mapping.tags_path | string | No | Length: 1–200 |
config | object | Yes | |
config.url | string (uri) | No | Length: 0–2000 |
config.method | enum | No | Values: "GET", "POST" |
config.headers | map<string, string> | No | |
config.body | string | No | Length: 0–10000 |
config.interval_minutes | integer | No | Range: 5–1440 |
config.auth_header | string | No | |
config.next_cursor_path | string | No | Length: 1–200 |
config.cursor_param | string | No | |
config.resume_cursor | boolean | No | |
has_secret | boolean | Yes | |
webhook_url | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
last_status | string | null | Yes | |
last_error | string | null | Yes | |
last_stats | map<string, number> | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
secret | string | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"target": "event",
"enabled": true,
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"kind": "webhook",
"auth_mode": "signature",
"mapping": {
"records_path": "örnek",
"event_name": "purchase",
"event_name_path": "örnek",
"external_id_path": "örnek"
},
"config": {
"url": "https://pushizo.com/orders/1001",
"method": "GET",
"headers": {
"key": "user_42"
},
"body": "Takip bağlantısı içeride"
},
"has_secret": true,
"webhook_url": "https://pushizo.com/orders/1001",
"next_run_at": "örnek",
"last_run_at": "örnek",
"last_status": "örnek",
"last_error": "örnek",
"last_stats": {
"key": 149.9
},
"created_at": "örnek",
"updated_at": "örnek",
"secret": "ö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 POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/data-pipelines/sources/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/rotate-secret" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Run the HTTP pull source now
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
sourceId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: DataSourceRunResult
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | Yes | Values: "succeeded", "partial", "failed", "skipped" |
stats | object | Yes | |
stats.received | integer | Yes | |
stats.processed | integer | Yes | |
stats.dropped | integer | Yes | |
stats.quarantined | integer | Yes | |
error | string | null | Yes |
Example response:
{
"status": "succeeded",
"stats": {
"received": 1,
"processed": 1,
"dropped": 1,
"quarantined": 1
},
"error": "ö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 POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/data-pipelines/sources/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/run" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Quarantined records
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
status | query | enum | No | Values: "pending", "reprocessed", "discarded" | "pending" |
target | query | enum | No | Values: "event", "person" | "event" |
source_id | query | string | No | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
transform_id | query | string | No | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
limit | query | integer | No | Range: 1–100 | 50 |
cursor | query | string | No | "eyJpZCI6Im1zZ18wMUpE…" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: DataQuarantineList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].target | enum | Yes | Values: "event", "person" |
data[].source | string | Yes | |
data[].source_id | string | null | Yes | |
data[].transform_id | string | null | Yes | |
data[].payload | map<string, any> | Yes | |
data[].error_code | enum | Yes | Values: "mapping_failed", "invalid_path", "cast_failed", "rule_failed", "invalid_output", "js_error", "js_timeout", "js_memory", "js_invalid_return", "sandbox_unavailable", "write_failed" |
data[].error_path | string | null | Yes | |
data[].error_message | string | null | Yes | |
data[].status | enum | Yes | Values: "pending", "reprocessed", "discarded" |
data[].attempts | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
data[].resolved_at | string | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes | |
pending_total | integer | Yes |
Example response:
{
"data": [
{
"target": "event",
"status": "pending",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"source": "örnek",
"source_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"transform_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"payload": {
"key": "örnek"
},
"error_code": "mapping_failed",
"error_path": "örnek",
"error_message": "örnek",
"attempts": 1,
"created_at": "örnek",
"updated_at": "örnek",
"resolved_at": "örnek"
}
],
"next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
"has_more": true,
"pending_total": 1
}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/data-pipelines/quarantine?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Reprocess quarantined records
If no IDs are given, the oldest 500 pending records are processed.
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)
Schema: ReprocessQuarantineDto
| Field | Type | Required | Description |
|---|---|---|---|
ids | array<string> | No | Items: 1–500 |
Example:
{
"ids": [
"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
]
}Responses
200 — Success.
Schema: DataQuarantineReprocessResult
| Field | Type | Required | Description |
|---|---|---|---|
reprocessed | integer | Yes | |
dropped | integer | Yes | |
failed | integer | Yes |
Example response:
{
"reprocessed": 1,
"dropped": 1,
"failed": 1
}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/data-pipelines/quarantine/reprocess" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"ids": [
"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
]
}'Discard quarantined records without reprocessing
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)
Schema: DiscardQuarantineDto
| Field | Type | Required | Description |
|---|---|---|---|
ids | array<string> | Yes | Items: 1–500 |
Example:
{
"ids": [
"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
]
}Responses
200 — Success.
Schema: DataQuarantineDiscardResult
| Field | Type | Required | Description |
|---|---|---|---|
discarded | integer | Yes |
Example response:
{
"discarded": 1
}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/data-pipelines/quarantine/discard" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"ids": [
"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
]
}'Zapier connection test: the key's app and scopes
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ZapierMe
| Field | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | |
app_name | string | Yes | |
org_id | string | Yes | |
scopes | array<string> | Yes |
Example response:
{
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_name": "örnek",
"org_id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"scopes": [
"notifications:write"
]
}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/integrations/zapier/me" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Zapier REST Hook subscriptions
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ZapierHookList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].event | string | Yes | |
data[].event_name | string | null | Yes | |
data[].target_url | string | Yes | |
data[].last_delivered_at | string | null | Yes | |
data[].failure_count | integer | Yes | |
data[].created_at | string | Yes |
Example response:
{
"data": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"event": "purchase",
"event_name": "purchase",
"target_url": "https://pushizo.com/orders/1001",
"last_delivered_at": "örnek",
"failure_count": 1,
"created_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/integrations/zapier/hooks" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"REST Hook subscription (Zap turned on)
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: ZapierSubscribeDto
| Field | Type | Required | Description |
|---|---|---|---|
target_url | string | Yes | Length: 1–2000 |
event | enum | Yes | Values: "subscription.created", "subscription.unsubscribed", "event.received", "delivery.delivered", "delivery.opened", "delivery.clicked", "user.created", "user.updated", "conversion.created", "campaign.completed" |
event_name | string | No | Length: 1–100 |
Example:
{
"target_url": "https://pushizo.com/orders/1001",
"event": "subscription.created",
"event_name": "purchase"
}Responses
201 — Success.
Schema: ZapierHook
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
event | string | Yes | |
event_name | string | null | Yes | |
target_url | string | Yes | |
last_delivered_at | string | null | Yes | |
failure_count | integer | Yes | |
created_at | string | Yes |
Example response:
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"event": "purchase",
"event_name": "purchase",
"target_url": "https://pushizo.com/orders/1001",
"last_delivered_at": "örnek",
"failure_count": 1,
"created_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 POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/integrations/zapier/hooks" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"target_url": "https://pushizo.com/orders/1001",
"event": "subscription.created",
"event_name": "purchase"
}'Delete a REST Hook subscription (Zap turned off)
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
hookId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: IntegrationOk
| 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/integrations/zapier/hooks/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Trigger samples (performList): recent records, in the same format as the subscription body
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
event | query | enum | Yes | Values: "subscription.created", "subscription.unsubscribed", "event.received", "delivery.delivered", "delivery.opened", "delivery.clicked", "user.created", "user.updated", "conversion.created", "campaign.completed" | "subscription.created" |
event_name | query | string | No | Length: 1–100 | "purchase" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ZapierSamples
Type: ZapierSamples
Example response:
[
{
"data": {
"order_id": "1001"
},
"type": "örnek",
"id": "srs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"created_at": "örnek",
"app_id": "app_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/integrations/zapier/samples?event=subscription.created" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Connected integrations and the catalog
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: IntegrationList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].type | enum | Yes | Values: "segment", "amplitude", "mixpanel", "ga4", "posthog", "rudderstack", "hubspot", "appsflyer", "adjust", "revenuecat", "zapier", "slack", "activecampaign", "adobe_audience_manager", "salesforce" |
data[].name | string | Yes | |
data[].status | enum | Yes | Values: "active", "paused", "error" |
data[].settings | map<string, any> | Yes | |
data[].events | array<string> | Yes | |
data[].credentials | map<string, string> | Yes | |
data[].state | map<string, any> | Yes | |
data[].inbound_url | string | null | Yes | |
data[].interactions_url | string | null | Yes | |
data[].pending_events | integer | Yes | |
data[].dead_events | integer | Yes | |
data[].hooks | integer | Yes | |
data[].consecutive_failures | integer | Yes | |
data[].last_error | string | null | Yes | |
data[].last_error_at | string | null | Yes | |
data[].last_success_at | string | null | Yes | |
data[].last_run_at | string | null | Yes | |
data[].next_sync_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
catalog | array<object> | Yes | |
catalog[].type | enum | Yes | Values: "segment", "amplitude", "mixpanel", "ga4", "posthog", "rudderstack", "hubspot", "appsflyer", "adjust", "revenuecat", "zapier", "slack", "activecampaign", "adobe_audience_manager", "salesforce" |
catalog[].events | array<string> | Yes | |
catalog[].cohorts | boolean | Yes | |
catalog[].inbound | boolean | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"events": [
"purchase"
],
"type": "segment",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"settings": {},
"credentials": {
"key": "user_42"
},
"state": {
"key": "örnek"
},
"inbound_url": "https://pushizo.com/orders/1001",
"interactions_url": "https://pushizo.com/orders/1001",
"pending_events": 1,
"dead_events": 1,
"hooks": 1,
"consecutive_failures": 1,
"last_error": "örnek",
"last_error_at": "örnek",
"last_success_at": "örnek",
"last_run_at": "örnek",
"next_sync_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}
],
"catalog": [
{
"events": [
"purchase"
],
"type": "segment",
"cohorts": true,
"inbound": 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/integrations" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Integration details (credentials masked)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
type | path | string | Yes | "örnek" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Integration
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
type | enum | Yes | Values: "segment", "amplitude", "mixpanel", "ga4", "posthog", "rudderstack", "hubspot", "appsflyer", "adjust", "revenuecat", "zapier", "slack", "activecampaign", "adobe_audience_manager", "salesforce" |
name | string | Yes | |
status | enum | Yes | Values: "active", "paused", "error" |
settings | map<string, any> | Yes | |
events | array<string> | Yes | |
credentials | map<string, string> | Yes | |
state | map<string, any> | Yes | |
inbound_url | string | null | Yes | |
interactions_url | string | null | Yes | |
pending_events | integer | Yes | |
dead_events | integer | Yes | |
hooks | integer | Yes | |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
last_error_at | string | null | Yes | |
last_success_at | string | null | Yes | |
last_run_at | string | null | Yes | |
next_sync_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"events": [
"purchase"
],
"type": "segment",
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"settings": {},
"credentials": {
"key": "user_42"
},
"state": {
"key": "örnek"
},
"inbound_url": "https://pushizo.com/orders/1001",
"interactions_url": "https://pushizo.com/orders/1001",
"pending_events": 1,
"dead_events": 1,
"hooks": 1,
"consecutive_failures": 1,
"last_error": "örnek",
"last_error_at": "örnek",
"last_success_at": "örnek",
"last_run_at": "örnek",
"next_sync_at": "ö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/integrations/örnek" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Recent runs (sync, event export, inbound requests, tests)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
type | path | string | Yes | "örnek" | |
limit | query | integer | No | Range: 1–100 | 50 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: IntegrationRunList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].kind | enum | Yes | Values: "cohort_sync", "event_export", "hook_delivery", "inbound", "notification", "test" |
data[].trigger | enum | Yes | Values: "schedule", "manual", "event", "inbound" |
data[].status | enum | Yes | Values: "running", "succeeded", "partial", "failed" |
data[].stats | map<string, number> | Yes | |
data[].error | string | null | Yes | |
data[].started_at | string | Yes | |
data[].finished_at | string | null | Yes | |
data[].duration_ms | integer | null | Yes |
Example response:
{
"data": [
{
"status": "running",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"kind": "cohort_sync",
"trigger": "schedule",
"stats": {
"key": 149.9
},
"error": "örnek",
"started_at": "örnek",
"finished_at": "örnek",
"duration_ms": 1
}
]
}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/integrations/örnek/runs?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Connection test
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
type | path | string | Yes | "örnek" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: IntegrationTestResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | |
error | string | null | Yes | |
run_id | string | Yes |
Example response:
{
"ok": true,
"error": "örnek",
"run_id": "run_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/integrations/örnek/test" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Run the cohort sync now (the worker picks it up within 1 minute)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
type | path | string | Yes | "örnek" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
202 — Success.
Schema: IntegrationSyncResult
| Field | Type | Required | Description |
|---|---|---|---|
queued | true | Yes | |
next_sync_at | string | Yes |
Example response:
{
"queued": true,
"next_sync_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 POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/integrations/örnek/sync" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Data warehouse export
Data warehouse export — 10 operations (GET /v1/apps/{appId}/warehouse-exports/tables, POST /v1/apps/{appId}/warehouse-exports/test-connection, GET /v1/apps/{appId}/warehouse-exports, …). Generated from the OpenAPI 3.1.0 contract.
Ads (audiences, campaigns, attribution)
Ads (audiences, campaigns, attribution) — 33 operations (GET /v1/apps/{appId}/ads/platforms, GET /v1/apps/{appId}/ads/accounts, GET /v1/apps/{appId}/ads/audiences, …). Generated from the OpenAPI 3.1.0 contract.