PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/data-pipelines/transformsData transformations
POST/v1/apps/{appId}/data-pipelines/transformsCreate a data transformation
POST/v1/apps/{appId}/data-pipelines/transforms/previewTransformation 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/sourcesData sources (webhook and HTTP pull)
POST/v1/apps/{appId}/data-pipelines/sourcesCreate 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-secretRotate the webhook source key
POST/v1/apps/{appId}/data-pipelines/sources/{sourceId}/runRun the HTTP pull source now
GET/v1/apps/{appId}/data-pipelines/quarantineQuarantined records
POST/v1/apps/{appId}/data-pipelines/quarantine/reprocessReprocess quarantined records
POST/v1/apps/{appId}/data-pipelines/quarantine/discardDiscard quarantined records without reprocessing
GET/v1/apps/{appId}/integrations/zapier/meZapier connection test: the key's app and scopes
GET/v1/apps/{appId}/integrations/zapier/hooksZapier REST Hook subscriptions
POST/v1/apps/{appId}/integrations/zapier/hooksREST 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/samplesTrigger samples (performList): recent records, in the same format as the subscription body
GET/v1/apps/{appId}/integrationsConnected integrations and the catalog
GET/v1/apps/{appId}/integrations/{type}Integration details (credentials masked)
GET/v1/apps/{appId}/integrations/{type}/runsRecent runs (sync, event export, inbound requests, tests)
POST/v1/apps/{appId}/integrations/{type}/testConnection test
POST/v1/apps/{appId}/integrations/{type}/syncRun the cohort sync now (the worker picks it up within 1 minute)

Details

Data transformations

GET/v1/apps/{appId}/data-pipelines/transformsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
targetqueryenumNoValues: "event", "person""event"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: DataTransformList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstringYes
data[].enabledbooleanYes
data[].targetenumYesValues: "event", "person"
data[].kindenumYesValues: "rules", "javascript"
data[].positionintegerYes
data[].sourcesarray<enum>Yes
data[].event_namesarray<string>Yes
data[].rulesarray<map<string, any>>Yes
data[].codestring | nullYes
data[].error_countintegerYes
data[].last_error_codeenum | nullYes
data[].last_error_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

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

POST/v1/apps/{appId}/data-pipelines/transformsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateDataTransformDto

FieldTypeRequiredDescription
namestringYesLength: 1–80
descriptionstringNoLength: 0–500
enabledbooleanNo
targetenumYesValues: "event", "person"
kindenumYesValues: "rules", "javascript"
positionintegerNoRange: 0–10000
rulesarray<object>NoItems: 0–50
codestringNoLength: 0–20000
sourcesarray<enum>NoItems: 0–6
event_namesarray<string>NoItems: 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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstringYes
enabledbooleanYes
targetenumYesValues: "event", "person"
kindenumYesValues: "rules", "javascript"
positionintegerYes
sourcesarray<enum>Yes
event_namesarray<string>Yes
rulesarray<map<string, any>>Yes
codestring | nullYes
error_countintegerYes
last_error_codeenum | nullYes
last_error_atstring | nullYes
created_atstringYes
updated_atstringYes

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)

POST/v1/apps/{appId}/data-pipelines/transforms/previewTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: PreviewDataTransformDto

FieldTypeRequiredDescription
targetenumYesValues: "event", "person"
sourceenumNoValues: "sdk", "api", "import", "system", "webhook_source", "pull_source"
recordsarray<map<string, any>>YesItems: 1–20
transformobjectNo
transform.kindenumYesValues: "rules", "javascript"
transform.rulesarray<object>NoItems: 0–50
transform.codestringNoLength: 0–20000
transform.sourcesarray<enum>NoItems: 0–6
transform.event_namesarray<string>NoItems: 0–50
transform_idstringNo

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

FieldTypeRequiredDescription
resultsarray<object>Yes
results[].statusenumYesValues: "kept", "dropped", "failed"
results[].recordmap<string, any> | nullYes
results[].transform_idstring | nullYes
results[].error_codeenum | nullYes
results[].error_pathstring | nullYes
results[].error_messagestring | nullYes
results[].logsarray<string>Yes
duration_msintegerYes

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

GET/v1/apps/{appId}/data-pipelines/transforms/{transformId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
transformIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: DataTransform

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstringYes
enabledbooleanYes
targetenumYesValues: "event", "person"
kindenumYesValues: "rules", "javascript"
positionintegerYes
sourcesarray<enum>Yes
event_namesarray<string>Yes
rulesarray<map<string, any>>Yes
codestring | nullYes
error_countintegerYes
last_error_codeenum | nullYes
last_error_atstring | nullYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/data-pipelines/transforms/{transformId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
transformIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateDataTransformDto

FieldTypeRequiredDescription
namestringNoLength: 1–80
descriptionstringNoLength: 0–500
enabledbooleanNo
positionintegerNoRange: 0–10000
rulesarray<object>NoItems: 0–50
codestringNoLength: 0–20000
sourcesarray<enum>NoItems: 0–6
event_namesarray<string>NoItems: 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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstringYes
enabledbooleanYes
targetenumYesValues: "event", "person"
kindenumYesValues: "rules", "javascript"
positionintegerYes
sourcesarray<enum>Yes
event_namesarray<string>Yes
rulesarray<map<string, any>>Yes
codestring | nullYes
error_countintegerYes
last_error_codeenum | nullYes
last_error_atstring | nullYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/data-pipelines/transforms/{transformId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
transformIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"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)

GET/v1/apps/{appId}/data-pipelines/sourcesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: DataSourceList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].kindenumYesValues: "webhook", "http_pull"
data[].targetenumYesValues: "event", "person"
data[].enabledbooleanYes
data[].auth_modeenumYesValues: "signature", "token"
data[].mappingobjectYes
data[].mapping.records_pathstringNoLength: 1–200
data[].mapping.event_namestringNoLength: 1–100
data[].mapping.event_name_pathstringNoLength: 1–200
data[].mapping.external_id_pathstringNoLength: 1–200
data[].mapping.occurred_at_pathstringNoLength: 1–200
data[].mapping.value_pathstringNoLength: 1–200
data[].mapping.event_id_pathstringNoLength: 1–200
data[].mapping.properties_pathstringNoLength: 1–200
data[].mapping.tags_pathstringNoLength: 1–200
data[].configobjectYes
data[].config.urlstring (uri)NoLength: 0–2000
data[].config.methodenumNoValues: "GET", "POST"
data[].config.headersmap<string, string>No
data[].config.bodystringNoLength: 0–10000
data[].config.interval_minutesintegerNoRange: 5–1440
data[].config.auth_headerstringNo
data[].config.next_cursor_pathstringNoLength: 1–200
data[].config.cursor_paramstringNo
data[].config.resume_cursorbooleanNo
data[].has_secretbooleanYes
data[].webhook_urlstring | nullYes
data[].next_run_atstring | nullYes
data[].last_run_atstring | nullYes
data[].last_statusstring | nullYes
data[].last_errorstring | nullYes
data[].last_statsmap<string, number>Yes
data[].created_atstringYes
data[].updated_atstringYes

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

POST/v1/apps/{appId}/data-pipelines/sourcesTry it (interactive API docs, new tab)

The webhook source's signing/access key is returned only in this response.

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateDataSourceDto

FieldTypeRequiredDescription
namestringYesLength: 1–80
enabledbooleanNo
auth_modeenumNoValues: "signature", "token"
mappingobjectNo
mapping.records_pathstringNoLength: 1–200
mapping.event_namestringNoLength: 1–100
mapping.event_name_pathstringNoLength: 1–200
mapping.external_id_pathstringNoLength: 1–200
mapping.occurred_at_pathstringNoLength: 1–200
mapping.value_pathstringNoLength: 1–200
mapping.event_id_pathstringNoLength: 1–200
mapping.properties_pathstringNoLength: 1–200
mapping.tags_pathstringNoLength: 1–200
configobjectNo
config.urlstring (uri)NoLength: 0–2000
config.methodenumNoValues: "GET", "POST"
config.headersmap<string, string>No
config.bodystringNoLength: 0–10000
config.interval_minutesintegerNoRange: 5–1440
config.auth_headerstringNo
config.next_cursor_pathstringNoLength: 1–200
config.cursor_paramstringNo
config.resume_cursorbooleanNo
auth_valuestringNoLength: 0–2000
kindenumYesValues: "webhook", "http_pull"
targetenumYesValues: "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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
kindenumYesValues: "webhook", "http_pull"
targetenumYesValues: "event", "person"
enabledbooleanYes
auth_modeenumYesValues: "signature", "token"
mappingobjectYes
mapping.records_pathstringNoLength: 1–200
mapping.event_namestringNoLength: 1–100
mapping.event_name_pathstringNoLength: 1–200
mapping.external_id_pathstringNoLength: 1–200
mapping.occurred_at_pathstringNoLength: 1–200
mapping.value_pathstringNoLength: 1–200
mapping.event_id_pathstringNoLength: 1–200
mapping.properties_pathstringNoLength: 1–200
mapping.tags_pathstringNoLength: 1–200
configobjectYes
config.urlstring (uri)NoLength: 0–2000
config.methodenumNoValues: "GET", "POST"
config.headersmap<string, string>No
config.bodystringNoLength: 0–10000
config.interval_minutesintegerNoRange: 5–1440
config.auth_headerstringNo
config.next_cursor_pathstringNoLength: 1–200
config.cursor_paramstringNo
config.resume_cursorbooleanNo
has_secretbooleanYes
webhook_urlstring | nullYes
next_run_atstring | nullYes
last_run_atstring | nullYes
last_statusstring | nullYes
last_errorstring | nullYes
last_statsmap<string, number>Yes
created_atstringYes
updated_atstringYes
secretstring | nullYes

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

GET/v1/apps/{appId}/data-pipelines/sources/{sourceId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
sourceIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: DataSource

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
kindenumYesValues: "webhook", "http_pull"
targetenumYesValues: "event", "person"
enabledbooleanYes
auth_modeenumYesValues: "signature", "token"
mappingobjectYes
mapping.records_pathstringNoLength: 1–200
mapping.event_namestringNoLength: 1–100
mapping.event_name_pathstringNoLength: 1–200
mapping.external_id_pathstringNoLength: 1–200
mapping.occurred_at_pathstringNoLength: 1–200
mapping.value_pathstringNoLength: 1–200
mapping.event_id_pathstringNoLength: 1–200
mapping.properties_pathstringNoLength: 1–200
mapping.tags_pathstringNoLength: 1–200
configobjectYes
config.urlstring (uri)NoLength: 0–2000
config.methodenumNoValues: "GET", "POST"
config.headersmap<string, string>No
config.bodystringNoLength: 0–10000
config.interval_minutesintegerNoRange: 5–1440
config.auth_headerstringNo
config.next_cursor_pathstringNoLength: 1–200
config.cursor_paramstringNo
config.resume_cursorbooleanNo
has_secretbooleanYes
webhook_urlstring | nullYes
next_run_atstring | nullYes
last_run_atstring | nullYes
last_statusstring | nullYes
last_errorstring | nullYes
last_statsmap<string, number>Yes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/data-pipelines/sources/{sourceId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
sourceIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateDataSourceDto

FieldTypeRequiredDescription
namestringNoLength: 1–80
enabledbooleanNo
auth_modeenumNoValues: "signature", "token"
mappingobjectNo
mapping.records_pathstringNoLength: 1–200
mapping.event_namestringNoLength: 1–100
mapping.event_name_pathstringNoLength: 1–200
mapping.external_id_pathstringNoLength: 1–200
mapping.occurred_at_pathstringNoLength: 1–200
mapping.value_pathstringNoLength: 1–200
mapping.event_id_pathstringNoLength: 1–200
mapping.properties_pathstringNoLength: 1–200
mapping.tags_pathstringNoLength: 1–200
configobjectNo
config.urlstring (uri)NoLength: 0–2000
config.methodenumNoValues: "GET", "POST"
config.headersmap<string, string>No
config.bodystringNoLength: 0–10000
config.interval_minutesintegerNoRange: 5–1440
config.auth_headerstringNo
config.next_cursor_pathstringNoLength: 1–200
config.cursor_paramstringNo
config.resume_cursorbooleanNo
auth_valuestringNoLength: 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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
kindenumYesValues: "webhook", "http_pull"
targetenumYesValues: "event", "person"
enabledbooleanYes
auth_modeenumYesValues: "signature", "token"
mappingobjectYes
mapping.records_pathstringNoLength: 1–200
mapping.event_namestringNoLength: 1–100
mapping.event_name_pathstringNoLength: 1–200
mapping.external_id_pathstringNoLength: 1–200
mapping.occurred_at_pathstringNoLength: 1–200
mapping.value_pathstringNoLength: 1–200
mapping.event_id_pathstringNoLength: 1–200
mapping.properties_pathstringNoLength: 1–200
mapping.tags_pathstringNoLength: 1–200
configobjectYes
config.urlstring (uri)NoLength: 0–2000
config.methodenumNoValues: "GET", "POST"
config.headersmap<string, string>No
config.bodystringNoLength: 0–10000
config.interval_minutesintegerNoRange: 5–1440
config.auth_headerstringNo
config.next_cursor_pathstringNoLength: 1–200
config.cursor_paramstringNo
config.resume_cursorbooleanNo
has_secretbooleanYes
webhook_urlstring | nullYes
next_run_atstring | nullYes
last_run_atstring | nullYes
last_statusstring | nullYes
last_errorstring | nullYes
last_statsmap<string, number>Yes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/data-pipelines/sources/{sourceId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
sourceIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"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

POST/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

NameInTypeRequiredDescriptionExample
sourceIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: DataSourceWithSecret

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
kindenumYesValues: "webhook", "http_pull"
targetenumYesValues: "event", "person"
enabledbooleanYes
auth_modeenumYesValues: "signature", "token"
mappingobjectYes
mapping.records_pathstringNoLength: 1–200
mapping.event_namestringNoLength: 1–100
mapping.event_name_pathstringNoLength: 1–200
mapping.external_id_pathstringNoLength: 1–200
mapping.occurred_at_pathstringNoLength: 1–200
mapping.value_pathstringNoLength: 1–200
mapping.event_id_pathstringNoLength: 1–200
mapping.properties_pathstringNoLength: 1–200
mapping.tags_pathstringNoLength: 1–200
configobjectYes
config.urlstring (uri)NoLength: 0–2000
config.methodenumNoValues: "GET", "POST"
config.headersmap<string, string>No
config.bodystringNoLength: 0–10000
config.interval_minutesintegerNoRange: 5–1440
config.auth_headerstringNo
config.next_cursor_pathstringNoLength: 1–200
config.cursor_paramstringNo
config.resume_cursorbooleanNo
has_secretbooleanYes
webhook_urlstring | nullYes
next_run_atstring | nullYes
last_run_atstring | nullYes
last_statusstring | nullYes
last_errorstring | nullYes
last_statsmap<string, number>Yes
created_atstringYes
updated_atstringYes
secretstring | nullYes

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

POST/v1/apps/{appId}/data-pipelines/sources/{sourceId}/runTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
sourceIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: DataSourceRunResult

FieldTypeRequiredDescription
statusenumYesValues: "succeeded", "partial", "failed", "skipped"
statsobjectYes
stats.receivedintegerYes
stats.processedintegerYes
stats.droppedintegerYes
stats.quarantinedintegerYes
errorstring | nullYes

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

GET/v1/apps/{appId}/data-pipelines/quarantineTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
statusqueryenumNoValues: "pending", "reprocessed", "discarded""pending"
targetqueryenumNoValues: "event", "person""event"
source_idquerystringNo"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
transform_idquerystringNo"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoRange: 1–10050
cursorquerystringNo"eyJpZCI6Im1zZ18wMUpE…"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: DataQuarantineList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].targetenumYesValues: "event", "person"
data[].sourcestringYes
data[].source_idstring | nullYes
data[].transform_idstring | nullYes
data[].payloadmap<string, any>Yes
data[].error_codeenumYesValues: "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_pathstring | nullYes
data[].error_messagestring | nullYes
data[].statusenumYesValues: "pending", "reprocessed", "discarded"
data[].attemptsintegerYes
data[].created_atstringYes
data[].updated_atstringYes
data[].resolved_atstring | nullYes
next_cursorstring | nullYes
has_morebooleanYes
pending_totalintegerYes

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

POST/v1/apps/{appId}/data-pipelines/quarantine/reprocessTry it (interactive API docs, new tab)

If no IDs are given, the oldest 500 pending records are processed.

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: ReprocessQuarantineDto

FieldTypeRequiredDescription
idsarray<string>NoItems: 1–500

Example:

{
  "ids": [
    "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
  ]
}

Responses

200 — Success.

Schema: DataQuarantineReprocessResult

FieldTypeRequiredDescription
reprocessedintegerYes
droppedintegerYes
failedintegerYes

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

POST/v1/apps/{appId}/data-pipelines/quarantine/discardTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: DiscardQuarantineDto

FieldTypeRequiredDescription
idsarray<string>YesItems: 1–500

Example:

{
  "ids": [
    "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
  ]
}

Responses

200 — Success.

Schema: DataQuarantineDiscardResult

FieldTypeRequiredDescription
discardedintegerYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ZapierMe

FieldTypeRequiredDescription
app_idstringYes
app_namestringYes
org_idstringYes
scopesarray<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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ZapierHookList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].eventstringYes
data[].event_namestring | nullYes
data[].target_urlstringYes
data[].last_delivered_atstring | nullYes
data[].failure_countintegerYes
data[].created_atstringYes

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)

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: ZapierSubscribeDto

FieldTypeRequiredDescription
target_urlstringYesLength: 1–2000
eventenumYesValues: "subscription.created", "subscription.unsubscribed", "event.received", "delivery.delivered", "delivery.opened", "delivery.clicked", "user.created", "user.updated", "conversion.created", "campaign.completed"
event_namestringNoLength: 1–100

Example:

{
  "target_url": "https://pushizo.com/orders/1001",
  "event": "subscription.created",
  "event_name": "purchase"
}

Responses

201 — Success.

Schema: ZapierHook

FieldTypeRequiredDescription
idstringYes
eventstringYes
event_namestring | nullYes
target_urlstringYes
last_delivered_atstring | nullYes
failure_countintegerYes
created_atstringYes

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)

DELETE/v1/apps/{appId}/integrations/zapier/hooks/{hookId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
hookIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: IntegrationOk

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/integrations/zapier/hooks/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Trigger samples (performList): recent records, in the same format as the subscription body

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

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

Parameters

NameInTypeRequiredDescriptionExample
eventqueryenumYesValues: "subscription.created", "subscription.unsubscribed", "event.received", "delivery.delivered", "delivery.opened", "delivery.clicked", "user.created", "user.updated", "conversion.created", "campaign.completed""subscription.created"
event_namequerystringNoLength: 1–100"purchase"
appIdpathstringYes"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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: IntegrationList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].typeenumYesValues: "segment", "amplitude", "mixpanel", "ga4", "posthog", "rudderstack", "hubspot", "appsflyer", "adjust", "revenuecat", "zapier", "slack", "activecampaign", "adobe_audience_manager", "salesforce"
data[].namestringYes
data[].statusenumYesValues: "active", "paused", "error"
data[].settingsmap<string, any>Yes
data[].eventsarray<string>Yes
data[].credentialsmap<string, string>Yes
data[].statemap<string, any>Yes
data[].inbound_urlstring | nullYes
data[].interactions_urlstring | nullYes
data[].pending_eventsintegerYes
data[].dead_eventsintegerYes
data[].hooksintegerYes
data[].consecutive_failuresintegerYes
data[].last_errorstring | nullYes
data[].last_error_atstring | nullYes
data[].last_success_atstring | nullYes
data[].last_run_atstring | nullYes
data[].next_sync_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
catalogarray<object>Yes
catalog[].typeenumYesValues: "segment", "amplitude", "mixpanel", "ga4", "posthog", "rudderstack", "hubspot", "appsflyer", "adjust", "revenuecat", "zapier", "slack", "activecampaign", "adobe_audience_manager", "salesforce"
catalog[].eventsarray<string>Yes
catalog[].cohortsbooleanYes
catalog[].inboundbooleanYes

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)

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

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

Parameters

NameInTypeRequiredDescriptionExample
typepathstringYes"örnek"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Integration

FieldTypeRequiredDescription
idstringYes
app_idstringYes
typeenumYesValues: "segment", "amplitude", "mixpanel", "ga4", "posthog", "rudderstack", "hubspot", "appsflyer", "adjust", "revenuecat", "zapier", "slack", "activecampaign", "adobe_audience_manager", "salesforce"
namestringYes
statusenumYesValues: "active", "paused", "error"
settingsmap<string, any>Yes
eventsarray<string>Yes
credentialsmap<string, string>Yes
statemap<string, any>Yes
inbound_urlstring | nullYes
interactions_urlstring | nullYes
pending_eventsintegerYes
dead_eventsintegerYes
hooksintegerYes
consecutive_failuresintegerYes
last_errorstring | nullYes
last_error_atstring | nullYes
last_success_atstring | nullYes
last_run_atstring | nullYes
next_sync_atstring | nullYes
created_atstringYes
updated_atstringYes

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)

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

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

Parameters

NameInTypeRequiredDescriptionExample
typepathstringYes"örnek"
limitqueryintegerNoRange: 1–10050
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: IntegrationRunList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].kindenumYesValues: "cohort_sync", "event_export", "hook_delivery", "inbound", "notification", "test"
data[].triggerenumYesValues: "schedule", "manual", "event", "inbound"
data[].statusenumYesValues: "running", "succeeded", "partial", "failed"
data[].statsmap<string, number>Yes
data[].errorstring | nullYes
data[].started_atstringYes
data[].finished_atstring | nullYes
data[].duration_msinteger | nullYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
typepathstringYes"örnek"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: IntegrationTestResult

FieldTypeRequiredDescription
okbooleanYes
errorstring | nullYes
run_idstringYes

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)

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

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

Parameters

NameInTypeRequiredDescriptionExample
typepathstringYes"örnek"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

202 — Success.

Schema: IntegrationSyncResult

FieldTypeRequiredDescription
queuedtrueYes
next_sync_atstringYes

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"

On this page