PushizoDocs
API reference

SDK endpoints (client)

SDK endpoints (client) — 51 operations (GET /sdk/v1/apps/{appId}/config, POST /sdk/v1/apps/{appId}/subscriptions, PATCH /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}, …). Generated from the OpenAPI 3.1.0 contract.

Endpoints used by client SDKs. They work with proof of ownership (token_hash) instead of an API key and, when enforced, identity verification (identity_hash or JWT); called directly from the browser/device.

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

Operations

MethodPathOperation
GET/sdk/v1/apps/{appId}/configPublic app configuration for the SDK
POST/sdk/v1/apps/{appId}/subscriptionsDevice/channel registration (idempotent: the same token yields a single subscription)
PATCH/sdk/v1/apps/{appId}/subscriptions/{subscriptionId}Token refresh, device info, opt-in/out (proof of ownership: token_hash or identity_hash)
DELETE/sdk/v1/apps/{appId}/subscriptions/{subscriptionId}Delete a subscription (proof of ownership: token_hash or identity_hash)
POST/sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/loginLink the device to a user by external_id (the anonymous user is merged; proof of ownership: token_hash)
POST/sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/logoutMove the device to a new anonymous user (proof of ownership: token_hash or identity_hash)
PATCH/sdk/v1/apps/{appId}/users/{userId}Tag/property merge-patch (a hash is required if identity verification is enforced)
PATCH/sdk/v1/apps/{appId}/users/{userId}/identityAdd an alias to the user (User.addAlias; hash required if identity verification is enforced)
DELETE/sdk/v1/apps/{appId}/users/{userId}/identity/{label}Remove an alias from the user (User.removeAlias)
POST/sdk/v1/apps/{appId}/sessionsSession start (without duration) or end (with duration; proof of ownership: token_hash or identity_hash)
POST/sdk/v1/apps/{appId}/feature-flags/evaluateEvaluate feature flags
GET/sdk/v1/apps/{appId}/geofencesNearest geofences for the device to monitor
POST/sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/geofence-eventsGeofence transitions reported by the operating system
POST/sdk/v1/apps/{appId}/eventsBulk event reporting (up to 100)
POST/sdk/v1/apps/{appId}/deliveries/{deliveryId}/receivedDevice received the notification (confirmed delivery)
POST/sdk/v1/apps/{appId}/deliveries/{deliveryId}/dismissedNotification dismissed by the user (web notificationclose, Android swipe-away)
POST/sdk/v1/apps/{appId}/deliveries/{deliveryId}/openedNotification opened / button clicked
POST/sdk/v1/apps/{appId}/live-activities/tokensRegister a Live Activity token (push-to-start or activity update)
POST/sdk/v1/apps/{appId}/live-activities/tokens/deleteDelete a Live Activity token (activity ended or permission revoked)
POST/sdk/v1/apps/{appId}/errorsSDK error reports (up to 20; retained for 7 days)
GET/sdk/v1/apps/{appId}/chat/configChat widget settings (color, position, texts), online/business hours status and attachment limits
POST/sdk/v1/apps/{appId}/chat/identifyLink the visitor to a user (external_id + identity_hash/JWT) and/or a push subscription (token_hash)
GET/sdk/v1/apps/{appId}/chat/conversationThe visitor's conversation and unread message count (null if none yet)
GET/sdk/v1/apps/{appId}/chat/messagesMessages: missing ones with after_seq (oldest first), history with before_seq; sequence-numbered
POST/sdk/v1/apps/{appId}/chat/messagesSend a message (deduplicated by client_message_id; the first message opens the conversation)
POST/sdk/v1/apps/{appId}/chat/attachmentsSend a file/image attachment (multipart: file + visitor_id, visitor_token, client_message_id, text; up to 10 MB)
GET/sdk/v1/apps/{appId}/chat/attachments/{attachmentId}Attachment file (only from this visitor's conversation; download with ?download=true)
POST/sdk/v1/apps/{appId}/chat/typingVisitor typing indicator (real time to agents)
POST/sdk/v1/apps/{appId}/chat/ackRead / delivered receipt (sequence number; only moves forward)
POST/sdk/v1/apps/{appId}/chat/offlineLeave a message and email when offline / outside business hours
GET/sdk/v1/apps/{appId}/chat/streamLive chat stream (Server-Sent Events)
GET/sdk/v1/apps/{appId}/in-appIn-app messages that can be shown on the device (triggers are evaluated by the SDK)
GET/sdk/v1/apps/{appId}/placements/{key}Embedded placement content
POST/sdk/v1/apps/{appId}/in-app/{messageId}/eventsIn-app impression / click / dismiss
GET/sdk/v1/apps/{appId}/users/{userId}/inboxNotification inbox (the subscription must belong to the user; identity_hash if required)
POST/sdk/v1/apps/{appId}/users/{userId}/inbox/read-allMark all as read
POST/sdk/v1/apps/{appId}/users/{userId}/inbox/{itemId}/readMark as read
GET/sdk/v1/apps/{appId}/users/{userId}/cardsContent card feed (in pinned, priority, newest order; the subscription must belong to the user)
POST/sdk/v1/apps/{appId}/users/{userId}/cards/{itemId}/{event}Card event: impression, click or dismiss
DELETE/sdk/v1/apps/{appId}/users/{userId}/inbox/{itemId}Remove from inbox (archive)
GET/sdk/v1/apps/{appId}/preferencesThe device user's preferences and categories
PUT/sdk/v1/apps/{appId}/preferencesWrite the device user's preferences
POST/sdk/v1/apps/{appId}/attributionAttribution touches (UTM, fbclid/gclid/ttclid…); proof of ownership same as for events
GET/sdk/v1/apps/{appId}/web-campaignsPublished web campaigns (trigger/condition/frequency are evaluated in the SDK). ETag and 60 s cache: publishing changes are reflected within 1 minute at most.
POST/sdk/v1/apps/{appId}/web-campaigns/{campaignId}/eventsWeb campaign impression / click / dismiss / conversion
POST/sdk/v1/apps/{appId}/forms/{formId}/submissionsForm submission: creates or links a user/subscription, records consent, emits a journey event
POST/sdk/v1/apps/{appId}/surveys/{surveyId}/responsesSurvey response (web pop-up or native in-app UI)
GET/sdk/v1/apps/{appId}/web-personalizationsPublished personalization experiences (conditions/variants are evaluated in the SDK). ETag and 60 s cache.
POST/sdk/v1/apps/{appId}/web-personalizations/{personalizationId}/eventsPersonalization exposure / conversion event
POST/sdk/v1/apps/{appId}/searchSite search: results and (with mode=answer) an AI answer with sources from the site's own content. If an AI answer cannot be given, only results are returned.
POST/sdk/v1/apps/{appId}/search/eventsSearch event: clicked result

Details

Public app configuration for the SDK

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SdkConfig

FieldTypeRequiredDescription
app_idstringYes
namestringYes
api_urlstringYes
cell_idstring | nullYes
identity_verification_requiredbooleanYes
identity_verification_modeenumYesValues: "hmac", "jwt", "both"
platformsobjectYes
platforms.iosbooleanYes
platforms.androidbooleanYes
platforms.webbooleanYes
platforms.emailbooleanYes
platforms.smsbooleanYes
webobjectYes
web.vapid_public_keystring | nullYes
web.allowed_originsarray<string>Yes
web.service_worker_pathstring | nullYes
web.service_worker_scopestring | nullYes
web.promptobject | nullYes
web.welcome_notificationobject | nullYes
web.click_behaviorobject | nullYes
web.custom_linkobject | nullYes
web.prompt_backoff_daysarray<integer> | nullYes
sessionobjectYes
session.timeout_secondsintegerYes
in_appobjectYes
in_app.min_interval_secondsintegerYes
android_channelsarray<object>Yes
android_channels[].idstringYes
android_channels[].namestringYes
android_channels[].descriptionstring | nullYes
android_channels[].importanceenumYesValues: "low", "default", "high", "urgent"
android_channels[].soundstring | nullYes
android_channels[].vibrationbooleanYes
android_channels[].groupstring | nullYes
categoriesarray<object>Yes
categories[].keystringYes
categories[].namemap<string, string>Yes
categories[].descriptionmap<string, string>Yes
categories[].channelsarray<string> | nullYes
categories[].default_opted_inbooleanYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "api_url": "https://pushizo.com/orders/1001",
  "cell_id": "cac_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "identity_verification_required": true,
  "identity_verification_mode": "hmac",
  "platforms": {
    "ios": true,
    "android": true,
    "web": true,
    "email": true,
    "sms": true
  },
  "web": {
    "vapid_public_key": "örnek",
    "allowed_origins": [
      "örnek"
    ],
    "service_worker_path": "örnek",
    "service_worker_scope": "örnek",
    "prompt": {
      "type": "slidedown",
      "enabled": true,
      "collect": "push",
      "delaySeconds": 1
    },
    "welcome_notification": {
      "enabled": true,
      "url": "https://pushizo.com/orders/1001",
      "texts": {
        "key": {
          "title": "Siparişiniz yola çıktı"
        }
      }
    },
    "click_behavior": {
      "match": "exact",
      "action": "navigate"
    },
    "custom_link": {
      "enabled": true,
      "style": "button",
      "size": "small",
      "color": {
        "button": "örnek"
      },
      "texts": {
        "key": {
          "subscribe": "örnek"
        }
      }
    },
    "prompt_backoff_days": [
      1
    ]
  },
  "session": {
    "timeout_seconds": 1
  },
  "in_app": {
    "min_interval_seconds": 1
  },
  "android_channels": [
    {
      "name": "Sipariş bildirimleri",
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "description": "Sipariş durumu güncellemeleri",
      "importance": "low",
      "sound": "örnek",
      "vibration": true,
      "group": "orders"
    }
  ],
  "categories": [
    {
      "name": {
        "key": "user_42"
      },
      "channels": [
        "web_push"
      ],
      "key": "key-2026-10",
      "description": {
        "key": "user_42"
      },
      "default_opted_in": 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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/config"

Device/channel registration (idempotent: the same token yields a single subscription)

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkRegisterDto

FieldTypeRequiredDescription
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs"
tokenstringYesLength: 1–4096
deviceobjectNoDefault: {}
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
test_devicebooleanNo
userobjectNo
user.external_idstringNoLength: 1–255
user.identity_hashstringNoLength: 64–64
user.tagsmap<string, string>No
user.propertiesmap<string, any>No
user.subscription_idstringNoLength: 1–64
user.token_hashstringNo
ownership_proofbooleanNo

Example:

{
  "channel": "ios_push",
  "token": "d1f2e3…",
  "device": {},
  "test_device": true,
  "user": {
    "tags": {
      "plan": "pro",
      "city": "Istanbul"
    },
    "properties": {
      "order_id": "1001"
    },
    "external_id": "user_42"
  },
  "ownership_proof": true
}

Responses

200 — Success.

Schema: SdkRegisterResult

FieldTypeRequiredDescription
subscription_idstringYes
user_idstringYes
external_idstring | nullYes
statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
createdbooleanYes

Example response:

{
  "status": "subscribed",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42",
  "created": 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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions" \
  -H "Content-Type: application/json" \
  -d '{
  "channel": "ios_push",
  "token": "d1f2e3…",
  "device": {},
  "test_device": true,
  "user": {
    "tags": {
      "plan": "pro",
      "city": "Istanbul"
    },
    "properties": {
      "order_id": "1001"
    },
    "external_id": "user_42"
  },
  "ownership_proof": true
}'

Token refresh, device info, opt-in/out (proof of ownership: token_hash or identity_hash)

PATCH/sdk/v1/apps/{appId}/subscriptions/{subscriptionId}Try it (interactive API docs, new tab)

The proof is the SHA-256 digest of the registered token (token_hash) or the subscription user's identity_hash. For push subscriptions it is required if the subscription was registered with ownership_proof: true or has sent a valid proof once; for email/SMS subscriptions it is always required. A wrong proof returns 403 (ADR-0016).

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
subscriptionIdpathstringYes"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkSubscriptionPatchDto

FieldTypeRequiredDescription
token_hashstringNo
identity_hashstringNoLength: 64–64
tokenstringNoLength: 1–4096
deviceobjectNo
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
opted_inbooleanNo
locationobject | nullNo
advertising_idstring | nullNo

Example:

{
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9",
  "token": "d1f2e3…",
  "device": {
    "model": "örnek",
    "os": "örnek",
    "os_version": "örnek"
  },
  "opted_in": true
}

Responses

200 — Success.

Schema: Subscription

FieldTypeRequiredDescription
idstringYes
app_idstringYes
user_idstring | nullYes
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
tokenstringYes
statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
unsubscribe_reasonenum | nullYes
deviceobjectYes
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
test_devicebooleanYes
test_device_namestring | nullYes
last_active_atstringYes
last_sent_atstring | nullYes
last_delivered_atstring | nullYes
opted_in_atstring | nullYes
opt_in_sourcestring | nullYes
unsubscribed_atstring | nullYes
locationobject | nullYes
created_atstringYes

Example response:

{
  "channel": "ios_push",
  "status": "subscribed",
  "id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token": "d1f2e3…",
  "unsubscribe_reason": "provider_rejected",
  "device": {
    "model": "örnek",
    "os": "örnek",
    "os_version": "örnek",
    "app_version": "örnek"
  },
  "test_device": true,
  "test_device_name": "örnek",
  "last_active_at": "örnek",
  "last_sent_at": "örnek",
  "last_delivered_at": "örnek",
  "opted_in_at": "örnek",
  "opt_in_source": "örnek",
  "unsubscribed_at": "örnek",
  "location": {
    "lat": 1.5,
    "lng": 1.5,
    "accuracy_m": 1.5,
    "geohash": "örnek",
    "updated_at": "örnek",
    "consent_at": "örnek"
  },
  "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 PATCH "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Content-Type: application/json" \
  -d '{
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9",
  "token": "d1f2e3…",
  "device": {
    "model": "örnek",
    "os": "örnek",
    "os_version": "örnek"
  },
  "opted_in": true
}'

Delete a subscription (proof of ownership: token_hash or identity_hash)

DELETE/sdk/v1/apps/{appId}/subscriptions/{subscriptionId}Try it (interactive API docs, new tab)

Proof rules are the same as for PATCH (ADR-0016).

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
subscriptionIdpathstringYes"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
token_hashquerystringNo"sha256-hex…"
identity_hashquerystringNoLength: 64–64"3f6c…b1e9"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

curl -X DELETE "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Link the device to a user by external_id (the anonymous user is merged; proof of ownership: token_hash)

POST/sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/loginTry it (interactive API docs, new tab)

The proof of ownership is token_hash (SHA-256 digest of the registered token); identity_hash counts as proof only if the subscription is already linked to the same external_id. Rules are the same as for PATCH (ADR-0016).

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
subscriptionIdpathstringYes"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkLoginDto

FieldTypeRequiredDescription
external_idstringYesLength: 1–255
identity_hashstringNoLength: 64–64
token_hashstringNo

Example:

{
  "external_id": "user_42",
  "identity_hash": "3f6c…b1e9",
  "token_hash": "sha256-hex…"
}

Responses

200 — Success.

Schema: SdkUserResult

FieldTypeRequiredDescription
user_idstringYes
external_idstring | nullYes
tagsmap<string, string>Yes

Example response:

{
  "tags": {
    "plan": "pro",
    "city": "Istanbul"
  },
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42"
}

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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W/login" \
  -H "Content-Type: application/json" \
  -d '{
  "external_id": "user_42",
  "identity_hash": "3f6c…b1e9",
  "token_hash": "sha256-hex…"
}'

Move the device to a new anonymous user (proof of ownership: token_hash or identity_hash)

POST/sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/logoutTry it (interactive API docs, new tab)

Proof rules are the same as for PATCH (ADR-0016); the body may be empty.

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
subscriptionIdpathstringYes"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (optional)

Schema: SdkLogoutDto

FieldTypeRequiredDescription
token_hashstringNo
identity_hashstringNoLength: 64–64

Example:

{
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}

Responses

200 — Success.

Schema: SdkUserResult

FieldTypeRequiredDescription
user_idstringYes
external_idstring | nullYes
tagsmap<string, string>Yes

Example response:

{
  "tags": {
    "plan": "pro",
    "city": "Istanbul"
  },
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42"
}

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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W/logout" \
  -H "Content-Type: application/json" \
  -d '{
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}'

Tag/property merge-patch (a hash is required if identity verification is enforced)

PATCH/sdk/v1/apps/{appId}/users/{userId}Try it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
userIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkUserPatchDto

FieldTypeRequiredDescription
tagsmap<string, string | null>No
propertiesmap<string, any>No
deltasobjectNo
deltas.session_countintegerNoRange: -1000000–1000000
deltas.session_timeintegerNoRange: 0–31536000
deltas.purchasesarray<object>NoItems: 0–100
deltas.purchases[].skustringYesLength: 1–100
deltas.purchases[].amountnumberYesRange: 0–∞
deltas.purchases[].isostringNoLength: 3–3
deltas.purchases[].countintegerNoDefault: 1; Range: 1–1000
identity_hashstringNoLength: 64–64

Example:

{
  "tags": {
    "plan": "pro",
    "city": "Istanbul"
  },
  "properties": {
    "order_id": "1001"
  },
  "deltas": {
    "session_count": 1,
    "session_time": 1,
    "purchases": [
      {
        "sku": "örnek",
        "amount": 149.9,
        "iso": "örnek"
      }
    ]
  },
  "identity_hash": "3f6c…b1e9"
}

Responses

200 — Success.

Schema: SdkUserResult

FieldTypeRequiredDescription
user_idstringYes
external_idstring | nullYes
tagsmap<string, string>Yes

Example response:

{
  "tags": {
    "plan": "pro",
    "city": "Istanbul"
  },
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42"
}

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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Content-Type: application/json" \
  -d '{
  "tags": {
    "plan": "pro",
    "city": "Istanbul"
  },
  "properties": {
    "order_id": "1001"
  },
  "deltas": {
    "session_count": 1,
    "session_time": 1,
    "purchases": [
      {
        "sku": "örnek",
        "amount": 149.9,
        "iso": "örnek"
      }
    ]
  },
  "identity_hash": "3f6c…b1e9"
}'

Add an alias to the user (User.addAlias; hash required if identity verification is enforced)

PATCH/sdk/v1/apps/{appId}/users/{userId}/identityTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
userIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkIdentityDto

FieldTypeRequiredDescription
identitymap<string, string>Yes
identity_hashstringNoLength: 64–64

Example:

{
  "identity": {
    "external_id": [
      "user_42"
    ]
  },
  "identity_hash": "3f6c…b1e9"
}

Responses

200 — Success.

Schema: SdkIdentityResult

FieldTypeRequiredDescription
identitymap<string, string>Yes

Example response:

{
  "identity": {
    "external_id": [
      "user_42"
    ]
  }
}

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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/identity" \
  -H "Content-Type: application/json" \
  -d '{
  "identity": {
    "external_id": [
      "user_42"
    ]
  },
  "identity_hash": "3f6c…b1e9"
}'

Remove an alias from the user (User.removeAlias)

DELETE/sdk/v1/apps/{appId}/users/{userId}/identity/{label}Try it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
userIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
labelpathstringYes"external_id"
identity_hashquerystringNoLength: 64–64"3f6c…b1e9"

Responses

200 — Success.

Schema: SdkIdentityResult

FieldTypeRequiredDescription
identitymap<string, string>Yes

Example response:

{
  "identity": {
    "external_id": [
      "user_42"
    ]
  }
}

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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/identity/external_id"

Session start (without duration) or end (with duration; proof of ownership: token_hash or identity_hash)

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

For the subscription_id subscription, proof rules are the same as for PATCH (ADR-0016).

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkSessionDto

FieldTypeRequiredDescription
token_hashstringNo
identity_hashstringNoLength: 64–64
subscription_idstringYesLength: 1–∞
duration_secondsintegerNoRange: 0–604800
app_versionstring | nullNo
sdk_versionstringNoLength: 0–50

Example:

{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9",
  "duration_seconds": 1,
  "app_version": "örnek",
  "sdk_version": "örnek"
}

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/sessions" \
  -H "Content-Type: application/json" \
  -d '{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9",
  "duration_seconds": 1,
  "app_version": "örnek",
  "sdk_version": "örnek"
}'

Evaluate feature flags

POST/sdk/v1/apps/{appId}/feature-flags/evaluateTry it (interactive API docs, new tab)

Values can be read by anyone who knows the app ID. Ownership rules for subscription_id are the same as for PATCH.

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkFlagsEvaluateDto

FieldTypeRequiredDescription
token_hashstringNo
identity_hashstringNoLength: 64–64
subscription_idstringNoLength: 1–64
subjectstringNoLength: 1–128

Example:

{
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subject": "Siparişiniz yola çıktı"
}

Responses

200 — Success.

Schema: SdkFeatureFlags

FieldTypeRequiredDescription
flagsmap<string, object>Yes

Example response:

{
  "flags": {
    "key": {
      "enabled": true,
      "value": "ö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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/feature-flags/evaluate" \
  -H "Content-Type: application/json" \
  -d '{
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subject": "Siparişiniz yola çıktı"
}'

Nearest geofences for the device to monitor

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

For background geofence monitoring; geofence names are not returned.

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
latquerynumberYesRange: -90–901.5
lngquerynumberYesRange: -180–1801.5
limitqueryintegerNoRange: 1–10050

Responses

200 — Success.

Schema: SdkGeofenceList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].latnumberYes
data[].lngnumberYes
data[].radius_mintegerYes

Example response:

{
  "data": [
    {
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "lat": 1.5,
      "lng": 1.5,
      "radius_m": 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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/geofences?lat=1.5&lng=1.5&limit=50"

Geofence transitions reported by the operating system

POST/sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/geofence-eventsTry it (interactive API docs, new tab)

Contains no coordinates. Ignored for subscriptions without location consent. Ownership rules are the same as for PATCH.

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
subscriptionIdpathstringYes"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkGeofenceEventsDto

FieldTypeRequiredDescription
token_hashstringNo
identity_hashstringNoLength: 64–64
eventsarray<object>YesItems: 1–20
events[].geofence_idstringYesLength: 1–64
events[].transitionenumYesValues: "enter", "exit"
events[].occurred_atstring (date-time)No

Example:

{
  "events": [
    {
      "geofence_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "transition": "enter",
      "occurred_at": "2026-10-17T09:00:00Z"
    }
  ],
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}

Responses

200 — Success.

Schema: EventsAccepted

FieldTypeRequiredDescription
acceptedintegerYes

Example response:

{
  "accepted": 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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W/geofence-events" \
  -H "Content-Type: application/json" \
  -d '{
  "events": [
    {
      "geofence_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "transition": "enter",
      "occurred_at": "2026-10-17T09:00:00Z"
    }
  ],
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}'

Bulk event reporting (up to 100)

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkEventsDto

FieldTypeRequiredDescription
eventsarray<object>YesItems: 1–100
events[].namestringYesLength: 1–100
events[].propertiesmap<string, any>NoDefault: {}
events[].valuenumberNo
events[].occurred_atstring (date-time)No
events[].event_idstringNoLength: 8–64
events[].subscription_idstringNoLength: 1–∞
events[].external_idstringNoLength: 1–255
events[].token_hashstringNo
events[].identity_hashstringNoLength: 64–64

Example:

{
  "events": [
    {
      "name": "purchase",
      "properties": {},
      "value": 149.9,
      "occurred_at": "2026-10-17T09:00:00Z"
    }
  ]
}

Responses

200 — Success.

Schema: EventsAccepted

FieldTypeRequiredDescription
acceptedintegerYes

Example response:

{
  "accepted": 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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/events" \
  -H "Content-Type: application/json" \
  -d '{
  "events": [
    {
      "name": "purchase",
      "properties": {},
      "value": 149.9,
      "occurred_at": "2026-10-17T09:00:00Z"
    }
  ]
}'

Device received the notification (confirmed delivery)

POST/sdk/v1/apps/{appId}/deliveries/{deliveryId}/receivedTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
deliveryIdpathstringYes"dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (optional)

Schema: ReceivedDto

FieldTypeRequiredDescription
received_atstring (date-time)No
deprioritizedbooleanNo

Example:

{
  "received_at": "2026-10-17T09:00:00Z",
  "deprioritized": true
}

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/deliveries/dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W/received" \
  -H "Content-Type: application/json" \
  -d '{
  "received_at": "2026-10-17T09:00:00Z",
  "deprioritized": true
}'

Notification dismissed by the user (web notificationclose, Android swipe-away)

POST/sdk/v1/apps/{appId}/deliveries/{deliveryId}/dismissedTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
deliveryIdpathstringYes"dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/deliveries/dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W/dismissed"

Notification opened / button clicked

POST/sdk/v1/apps/{appId}/deliveries/{deliveryId}/openedTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
deliveryIdpathstringYes"dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: OpenedDto

FieldTypeRequiredDescription
button_idstringNoLength: 0–64

Example:

{
  "button_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/deliveries/dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W/opened" \
  -H "Content-Type: application/json" \
  -d '{
  "button_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'

Register a Live Activity token (push-to-start or activity update)

POST/sdk/v1/apps/{appId}/live-activities/tokensTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkLiveActivityTokenDto

FieldTypeRequiredDescription
subscription_idstringYesLength: 1–64
activity_typestringYesLength: 1–100
kindenumYesValues: "push_to_start", "update"
activity_idstringNoLength: 1–100
tokenstringYes
token_hashstringNoLength: 64–64
identity_hashstringNoLength: 64–64

Example:

{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "activity_type": "order_tracking",
  "kind": "push_to_start",
  "token": "d1f2e3…",
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}

Responses

200 — Success.

Schema: LiveActivityTokenResult

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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/tokens" \
  -H "Content-Type: application/json" \
  -d '{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "activity_type": "order_tracking",
  "kind": "push_to_start",
  "token": "d1f2e3…",
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}'

Delete a Live Activity token (activity ended or permission revoked)

POST/sdk/v1/apps/{appId}/live-activities/tokens/deleteTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkLiveActivityTokenDeleteDto

FieldTypeRequiredDescription
subscription_idstringYesLength: 1–64
activity_typestringYesLength: 1–100
kindenumYesValues: "push_to_start", "update"
activity_idstringNoLength: 1–100
token_hashstringNoLength: 64–64
identity_hashstringNoLength: 64–64

Example:

{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "activity_type": "order_tracking",
  "kind": "push_to_start",
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}

Responses

200 — Success.

Schema: LiveActivityTokenResult

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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/tokens/delete" \
  -H "Content-Type: application/json" \
  -d '{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "activity_type": "order_tracking",
  "kind": "push_to_start",
  "activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}'

SDK error reports (up to 20; retained for 7 days)

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkErrorsDto

FieldTypeRequiredDescription
errorsarray<object>YesItems: 1–20
errors[].levelenumNoValues: "error", "warning"; Default: "error"
errors[].platformenumYesValues: "web", "android", "ios", "flutter", "react_native", "node"
errors[].sdk_versionstringNoLength: 0–50
errors[].codestringNoLength: 0–100
errors[].messagestringYesLength: 1–2000
errors[].subscription_idstringNoLength: 0–64
errors[].contextmap<string, any>No
errors[].occurred_atstring (date-time)No

Example:

{
  "errors": [
    {
      "platform": "web",
      "message": "Takip bağlantısı içeride",
      "level": "error",
      "sdk_version": "örnek",
      "code": "örnek"
    }
  ]
}

Responses

200 — Success.

Schema: SdkErrorsAccepted

FieldTypeRequiredDescription
acceptedintegerYes

Example response:

{
  "accepted": 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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/errors" \
  -H "Content-Type: application/json" \
  -d '{
  "errors": [
    {
      "platform": "web",
      "message": "Takip bağlantısı içeride",
      "level": "error",
      "sdk_version": "örnek",
      "code": "örnek"
    }
  ]
}'

Chat widget settings (color, position, texts), online/business hours status and attachment limits

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
languagequerystringNo"tr"

Responses

200 — Success.

Schema: SdkChatConfig

FieldTypeRequiredDescription
enabledbooleanYes
onlinebooleanYes
within_business_hoursbooleanYes
colorstring | nullYes
text_colorstring | nullYes
positionenumYesValues: "right", "left"
themeenumYesValues: "light", "dark", "auto"
titlestring | nullYes
greetingstring | nullYes
offline_messagestring | nullYes
collect_email_offlinebooleanYes
require_emailbooleanYes
attachmentsobjectYes
attachments.enabledbooleanYes
attachments.max_bytesintegerYes
attachments.typesarray<string>Yes
languagestringYes

Example response:

{
  "enabled": true,
  "online": true,
  "within_business_hours": true,
  "color": "örnek",
  "text_color": "örnek",
  "position": "right",
  "theme": "light",
  "title": "Siparişiniz yola çıktı",
  "greeting": "örnek",
  "offline_message": "örnek",
  "collect_email_offline": true,
  "require_email": true,
  "attachments": {
    "enabled": true,
    "max_bytes": 1,
    "types": [
      "örnek"
    ]
  },
  "language": "tr"
}

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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/config"

Link the visitor to a user (external_id + identity_hash/JWT) and/or a push subscription (token_hash)

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkChatIdentifyDto

FieldTypeRequiredDescription
visitor_idstringYes
visitor_tokenstringYes
external_idstringNoLength: 1–255
identity_hashstringNoLength: 16–128
subscription_idstringNoLength: 1–64
token_hashstringNo
namestringNoLength: 1–120
emailstring (email)NoLength: 0–320
languagestringNo

Example:

{
  "visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "visitor_token": "değer",
  "name": "Sipariş bildirimleri",
  "external_id": "user_42",
  "identity_hash": "3f6c…b1e9",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…"
}

Responses

200 — Success.

Schema: SdkChatIdentifyResult

FieldTypeRequiredDescription
user_idstring | nullYes
conversationobject | nullYes

Example response:

{
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "conversation": {
    "status": "open",
    "id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "last_seq": 1,
    "agent_last_read_seq": 1,
    "visitor_last_read_seq": 1,
    "unread_count": 1,
    "bot_active": true,
    "assignee_name": "örnek",
    "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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/identify" \
  -H "Content-Type: application/json" \
  -d '{
  "visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "visitor_token": "değer",
  "name": "Sipariş bildirimleri",
  "external_id": "user_42",
  "identity_hash": "3f6c…b1e9",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…"
}'

The visitor's conversation and unread message count (null if none yet)

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
visitor_idquerystringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
tokenquerystringYes"d1f2e3…"
after_seqqueryintegerNoRange: 0–∞1
before_seqqueryintegerNoRange: 1–∞1
limitqueryintegerNoRange: 1–10050

Responses

200 — Success.

Schema: SdkChatConversation

FieldTypeRequiredDescription
conversationobject | nullYes
unread_countintegerYes

Example response:

{
  "conversation": {
    "status": "open",
    "id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "last_seq": 1,
    "agent_last_read_seq": 1,
    "visitor_last_read_seq": 1,
    "unread_count": 1,
    "bot_active": true,
    "assignee_name": "örnek",
    "created_at": "örnek"
  },
  "unread_count": 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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/conversation?visitor_id=id_01JD3W5Q7X9K2M4N6P8R0T1V3W&token=d1f2e3%E2%80%A6&limit=50"

Messages: missing ones with after_seq (oldest first), history with before_seq; sequence-numbered

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
visitor_idquerystringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
tokenquerystringYes"d1f2e3…"
after_seqqueryintegerNoRange: 0–∞1
before_seqqueryintegerNoRange: 1–∞1
limitqueryintegerNoRange: 1–10050

Responses

200 — Success.

Schema: SdkChatMessagePage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].seqintegerYes
data[].client_message_idstring | nullYes
data[].senderenumYesValues: "visitor", "agent", "bot", "system"
data[].author_namestring | nullYes
data[].textstring | nullYes
data[].attachmentsarray<object>Yes
data[].attachments[].idstringYes
data[].attachments[].namestringYes
data[].attachments[].typestringYes
data[].attachments[].sizeintegerYes
data[].quick_repliesarray<object> | nullYes
data[].statusenumYesValues: "sent", "delivered", "read"
data[].created_atstringYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "status": "sent",
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "seq": 1,
      "client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "sender": "visitor",
      "author_name": "örnek",
      "text": "Takip bağlantısı içeride",
      "attachments": [
        {
          "name": "Sipariş bildirimleri",
          "type": "örnek",
          "id": "cha_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "size": 1
        }
      ],
      "quick_replies": [
        {
          "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "label": "external_id"
        }
      ],
      "created_at": "örnek"
    }
  ],
  "has_more": true
}

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

Examples

curl -X GET "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/messages?visitor_id=id_01JD3W5Q7X9K2M4N6P8R0T1V3W&token=d1f2e3%E2%80%A6&limit=50"

Send a message (deduplicated by client_message_id; the first message opens the conversation)

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkChatSendDto

FieldTypeRequiredDescription
visitor_idstringYes
visitor_tokenstringYes
client_message_idstringYes
textstringYesLength: 1–4000
option_idstringNoLength: 1–64
namestringNoLength: 1–120
emailstring (email)NoLength: 0–320
languagestringNo
page_urlstringNoLength: 0–2000

Example:

{
  "visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "visitor_token": "değer",
  "client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "text": "Takip bağlantısı içeride",
  "name": "Sipariş bildirimleri",
  "option_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "email": "ayse@pushizo.com",
  "language": "tr",
  "page_url": "https://pushizo.com/orders/1001"
}

Responses

200 — Success.

Schema: SdkChatSendResult

FieldTypeRequiredDescription
messageobjectYes
message.idstringYes
message.seqintegerYes
message.client_message_idstring | nullYes
message.senderenumYesValues: "visitor", "agent", "bot", "system"
message.author_namestring | nullYes
message.textstring | nullYes
message.attachmentsarray<object>Yes
message.attachments[].idstringYes
message.attachments[].namestringYes
message.attachments[].typestringYes
message.attachments[].sizeintegerYes
message.quick_repliesarray<object> | nullYes
message.statusenumYesValues: "sent", "delivered", "read"
message.created_atstringYes
conversationobjectYes
conversation.idstringYes
conversation.statusenumYesValues: "open", "pending", "resolved", "closed"
conversation.last_seqintegerYes
conversation.agent_last_read_seqintegerYes
conversation.visitor_last_read_seqintegerYes
conversation.unread_countintegerYes
conversation.bot_activebooleanYes
conversation.assignee_namestring | nullYes
conversation.created_atstringYes
duplicatebooleanYes

Example response:

{
  "message": {
    "status": "sent",
    "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "seq": 1,
    "client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "sender": "visitor",
    "author_name": "örnek",
    "text": "Takip bağlantısı içeride",
    "attachments": [
      {
        "name": "Sipariş bildirimleri",
        "type": "örnek",
        "id": "cha_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "size": 1
      }
    ],
    "quick_replies": [
      {
        "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "label": "external_id"
      }
    ],
    "created_at": "örnek"
  },
  "conversation": {
    "status": "open",
    "id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "last_seq": 1,
    "agent_last_read_seq": 1,
    "visitor_last_read_seq": 1,
    "unread_count": 1,
    "bot_active": true,
    "assignee_name": "örnek",
    "created_at": "örnek"
  },
  "duplicate": 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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/messages" \
  -H "Content-Type: application/json" \
  -d '{
  "visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "visitor_token": "değer",
  "client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "text": "Takip bağlantısı içeride",
  "name": "Sipariş bildirimleri",
  "option_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "email": "ayse@pushizo.com",
  "language": "tr",
  "page_url": "https://pushizo.com/orders/1001"
}'

Send a file/image attachment (multipart: file + visitor_id, visitor_token, client_message_id, text; up to 10 MB)

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SdkChatSendResult

FieldTypeRequiredDescription
messageobjectYes
message.idstringYes
message.seqintegerYes
message.client_message_idstring | nullYes
message.senderenumYesValues: "visitor", "agent", "bot", "system"
message.author_namestring | nullYes
message.textstring | nullYes
message.attachmentsarray<object>Yes
message.attachments[].idstringYes
message.attachments[].namestringYes
message.attachments[].typestringYes
message.attachments[].sizeintegerYes
message.quick_repliesarray<object> | nullYes
message.statusenumYesValues: "sent", "delivered", "read"
message.created_atstringYes
conversationobjectYes
conversation.idstringYes
conversation.statusenumYesValues: "open", "pending", "resolved", "closed"
conversation.last_seqintegerYes
conversation.agent_last_read_seqintegerYes
conversation.visitor_last_read_seqintegerYes
conversation.unread_countintegerYes
conversation.bot_activebooleanYes
conversation.assignee_namestring | nullYes
conversation.created_atstringYes
duplicatebooleanYes

Example response:

{
  "message": {
    "status": "sent",
    "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "seq": 1,
    "client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "sender": "visitor",
    "author_name": "örnek",
    "text": "Takip bağlantısı içeride",
    "attachments": [
      {
        "name": "Sipariş bildirimleri",
        "type": "örnek",
        "id": "cha_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "size": 1
      }
    ],
    "quick_replies": [
      {
        "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "label": "external_id"
      }
    ],
    "created_at": "örnek"
  },
  "conversation": {
    "status": "open",
    "id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "last_seq": 1,
    "agent_last_read_seq": 1,
    "visitor_last_read_seq": 1,
    "unread_count": 1,
    "bot_active": true,
    "assignee_name": "örnek",
    "created_at": "örnek"
  },
  "duplicate": 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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/attachments"

Attachment file (only from this visitor's conversation; download with ?download=true)

GET/sdk/v1/apps/{appId}/chat/attachments/{attachmentId}Try it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
attachmentIdpathstringYes"cha_01JD3W5Q7X9K2M4N6P8R0T1V3W"
visitor_idquerystringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
tokenquerystringYes"d1f2e3…"
after_seqqueryintegerNoRange: 0–∞1
before_seqqueryintegerNoRange: 1–∞1
limitqueryintegerNoRange: 1–10050

Responses

200 — Success.

No body defined.

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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/attachments/cha_01JD3W5Q7X9K2M4N6P8R0T1V3W?visitor_id=id_01JD3W5Q7X9K2M4N6P8R0T1V3W&token=d1f2e3%E2%80%A6&limit=50"

Visitor typing indicator (real time to agents)

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkChatTypingDto

FieldTypeRequiredDescription
visitor_idstringYes
visitor_tokenstringYes
typingbooleanYes

Example:

{
  "visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "visitor_token": "değer",
  "typing": true
}

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/typing" \
  -H "Content-Type: application/json" \
  -d '{
  "visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "visitor_token": "değer",
  "typing": true
}'

Read / delivered receipt (sequence number; only moves forward)

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkChatAckDto

FieldTypeRequiredDescription
visitor_idstringYes
visitor_tokenstringYes
read_seqintegerNoRange: 0–∞
delivered_seqintegerNoRange: 0–∞

Example:

{
  "visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "visitor_token": "değer",
  "read_seq": 1,
  "delivered_seq": 1
}

Responses

200 — Success.

Schema: SdkChatConversation

FieldTypeRequiredDescription
conversationobject | nullYes
unread_countintegerYes

Example response:

{
  "conversation": {
    "status": "open",
    "id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "last_seq": 1,
    "agent_last_read_seq": 1,
    "visitor_last_read_seq": 1,
    "unread_count": 1,
    "bot_active": true,
    "assignee_name": "örnek",
    "created_at": "örnek"
  },
  "unread_count": 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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/ack" \
  -H "Content-Type: application/json" \
  -d '{
  "visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "visitor_token": "değer",
  "read_seq": 1,
  "delivered_seq": 1
}'

Leave a message and email when offline / outside business hours

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkChatOfflineDto

FieldTypeRequiredDescription
visitor_idstringYes
visitor_tokenstringYes
client_message_idstringYes
emailstring (email)YesLength: 0–320
namestringNoLength: 1–120
textstringYesLength: 1–4000
languagestringNo

Example:

{
  "visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "visitor_token": "değer",
  "client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "email": "ayse@pushizo.com",
  "text": "Takip bağlantısı içeride",
  "name": "Sipariş bildirimleri",
  "language": "tr"
}

Responses

200 — Success.

Schema: SdkChatSendResult

FieldTypeRequiredDescription
messageobjectYes
message.idstringYes
message.seqintegerYes
message.client_message_idstring | nullYes
message.senderenumYesValues: "visitor", "agent", "bot", "system"
message.author_namestring | nullYes
message.textstring | nullYes
message.attachmentsarray<object>Yes
message.attachments[].idstringYes
message.attachments[].namestringYes
message.attachments[].typestringYes
message.attachments[].sizeintegerYes
message.quick_repliesarray<object> | nullYes
message.statusenumYesValues: "sent", "delivered", "read"
message.created_atstringYes
conversationobjectYes
conversation.idstringYes
conversation.statusenumYesValues: "open", "pending", "resolved", "closed"
conversation.last_seqintegerYes
conversation.agent_last_read_seqintegerYes
conversation.visitor_last_read_seqintegerYes
conversation.unread_countintegerYes
conversation.bot_activebooleanYes
conversation.assignee_namestring | nullYes
conversation.created_atstringYes
duplicatebooleanYes

Example response:

{
  "message": {
    "status": "sent",
    "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "seq": 1,
    "client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "sender": "visitor",
    "author_name": "örnek",
    "text": "Takip bağlantısı içeride",
    "attachments": [
      {
        "name": "Sipariş bildirimleri",
        "type": "örnek",
        "id": "cha_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "size": 1
      }
    ],
    "quick_replies": [
      {
        "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "label": "external_id"
      }
    ],
    "created_at": "örnek"
  },
  "conversation": {
    "status": "open",
    "id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "last_seq": 1,
    "agent_last_read_seq": 1,
    "visitor_last_read_seq": 1,
    "unread_count": 1,
    "bot_active": true,
    "assignee_name": "örnek",
    "created_at": "örnek"
  },
  "duplicate": 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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/offline" \
  -H "Content-Type: application/json" \
  -d '{
  "visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "visitor_token": "değer",
  "client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "email": "ayse@pushizo.com",
  "text": "Takip bağlantısı içeride",
  "name": "Sipariş bildirimleri",
  "language": "tr"
}'

Live chat stream (Server-Sent Events)

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
visitor_idquerystringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
tokenquerystringYes"d1f2e3…"
after_seqqueryintegerNoRange: 0–∞1
before_seqqueryintegerNoRange: 1–∞1
limitqueryintegerNoRange: 1–10050

Responses

200 — Success.

No body defined.

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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/stream?visitor_id=id_01JD3W5Q7X9K2M4N6P8R0T1V3W&token=d1f2e3%E2%80%A6&limit=50"

In-app messages that can be shown on the device (triggers are evaluated by the SDK)

GET/sdk/v1/apps/{appId}/in-appTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
subscription_idquerystringYesLength: 1–64"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
token_hashquerystringNo"sha256-hex…"
supportsquerystringNoLength: 0–200"değer"

Responses

200 — Success.

Schema: SdkInAppList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].priorityintegerYes
data[].triggersarray<object>Yes
data[].trigger_groupsarray<array<object>>Yes
data[].variant_idstring | nullYes
data[].displayobjectYes
data[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
data[].display.background_colorstring | nullYes
data[].display.text_colorstring | nullYes
data[].display.dismissiblebooleanYes
data[].display.auto_dismiss_secondsinteger | nullYes
data[].display.content_typeenumYesValues: "blocks", "html"
data[].display.htmlstring | nullYes
data[].display.html_heightinteger | nullYes
data[].display.blocksarray<object>Yes
data[].remaining_impressionsintegerYes
data[].min_interval_secondsintegerYes
data[].stop_after_interactionbooleanYes
data[].last_impression_atstring | nullYes
data[].end_atstring | nullYes
languagestringYes

Example response:

{
  "data": [
    {
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "priority": 10,
      "triggers": [
        {
          "kind": "session_start"
        }
      ],
      "trigger_groups": [
        [
          {}
        ]
      ],
      "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "display": {
        "layout": "modal",
        "background_color": "örnek",
        "text_color": "örnek",
        "dismissible": true,
        "auto_dismiss_seconds": 1,
        "content_type": "blocks",
        "html": "örnek",
        "html_height": 1,
        "blocks": [
          {}
        ]
      },
      "remaining_impressions": 1,
      "min_interval_seconds": 1,
      "stop_after_interaction": true,
      "last_impression_at": "örnek",
      "end_at": "örnek"
    }
  ],
  "language": "tr"
}

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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/in-app?subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Embedded placement content

GET/sdk/v1/apps/{appId}/placements/{key}Try it (interactive API docs, new tab)

Sorted by priority; report an impression via in-app/{id}/events once the content is rendered.

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
keypathstringYes"key-2026-10"
subscription_idquerystringYesLength: 1–64"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
token_hashquerystringNo"sha256-hex…"
supportsquerystringNoLength: 0–200"değer"
limitqueryintegerNoRange: 1–1050

Responses

200 — Success.

Schema: SdkInAppList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].priorityintegerYes
data[].triggersarray<object>Yes
data[].trigger_groupsarray<array<object>>Yes
data[].variant_idstring | nullYes
data[].displayobjectYes
data[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
data[].display.background_colorstring | nullYes
data[].display.text_colorstring | nullYes
data[].display.dismissiblebooleanYes
data[].display.auto_dismiss_secondsinteger | nullYes
data[].display.content_typeenumYesValues: "blocks", "html"
data[].display.htmlstring | nullYes
data[].display.html_heightinteger | nullYes
data[].display.blocksarray<object>Yes
data[].remaining_impressionsintegerYes
data[].min_interval_secondsintegerYes
data[].stop_after_interactionbooleanYes
data[].last_impression_atstring | nullYes
data[].end_atstring | nullYes
languagestringYes

Example response:

{
  "data": [
    {
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "priority": 10,
      "triggers": [
        {
          "kind": "session_start"
        }
      ],
      "trigger_groups": [
        [
          {}
        ]
      ],
      "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "display": {
        "layout": "modal",
        "background_color": "örnek",
        "text_color": "örnek",
        "dismissible": true,
        "auto_dismiss_seconds": 1,
        "content_type": "blocks",
        "html": "örnek",
        "html_height": 1,
        "blocks": [
          {}
        ]
      },
      "remaining_impressions": 1,
      "min_interval_seconds": 1,
      "stop_after_interaction": true,
      "last_impression_at": "örnek",
      "end_at": "örnek"
    }
  ],
  "language": "tr"
}

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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/placements/key-2026-10?subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W&limit=50"

In-app impression / click / dismiss

POST/sdk/v1/apps/{appId}/in-app/{messageId}/eventsTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
messageIdpathstringYes"msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkInAppEventDto

FieldTypeRequiredDescription
subscription_idstringYesLength: 1–64
token_hashstringNo
typeenumYesValues: "impression", "click", "dismiss"
button_idstringNoLength: 0–64
variant_idstringNoLength: 0–64

Example:

{
  "type": "impression",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "button_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/in-app/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W/events" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "impression",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "button_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'

Notification inbox (the subscription must belong to the user; identity_hash if required)

GET/sdk/v1/apps/{appId}/users/{userId}/inboxTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
userIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
subscription_idquerystringYesLength: 1–64"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
identity_hashquerystringNoLength: 0–128"3f6c…b1e9"
token_hashquerystringNo"sha256-hex…"

Responses

200 — Success.

Schema: InboxPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].message_idstring | nullYes
data[].titlestring | nullYes
data[].bodystring | nullYes
data[].urlstring | nullYes
data[].image_urlstring | nullYes
data[].datamap<string, string>Yes
data[].readbooleanYes
data[].read_atstring | nullYes
data[].archived_atstring | nullYes
data[].expires_atstring | nullYes
data[].created_atstringYes
unread_countintegerYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "url": "https://pushizo.com/orders/1001",
      "data": {
        "order_id": "1001"
      },
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "title": "Siparişiniz yola çıktı",
      "body": "Takip bağlantısı içeride",
      "image_url": "https://pushizo.com/orders/1001",
      "read": true,
      "read_at": "örnek",
      "archived_at": "örnek",
      "expires_at": "örnek",
      "created_at": "örnek"
    }
  ],
  "unread_count": 1,
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

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

Examples

curl -X GET "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox?limit=50&subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Mark all as read

POST/sdk/v1/apps/{appId}/users/{userId}/inbox/read-allTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
userIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkInboxActionDto

FieldTypeRequiredDescription
subscription_idstringYesLength: 1–64
identity_hashstringNoLength: 0–128
token_hashstringNo

Example:

{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "identity_hash": "3f6c…b1e9",
  "token_hash": "sha256-hex…"
}

Responses

200 — Success.

Schema: InboxReadAllResult

FieldTypeRequiredDescription
updatedintegerYes
unread_countintegerYes

Example response:

{
  "updated": 1,
  "unread_count": 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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox/read-all" \
  -H "Content-Type: application/json" \
  -d '{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "identity_hash": "3f6c…b1e9",
  "token_hash": "sha256-hex…"
}'

Mark as read

POST/sdk/v1/apps/{appId}/users/{userId}/inbox/{itemId}/readTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
userIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
itemIdpathstringYes"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkInboxActionDto

FieldTypeRequiredDescription
subscription_idstringYesLength: 1–64
identity_hashstringNoLength: 0–128
token_hashstringNo

Example:

{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "identity_hash": "3f6c…b1e9",
  "token_hash": "sha256-hex…"
}

Responses

200 — Success.

Schema: InboxItem

FieldTypeRequiredDescription
idstringYes
message_idstring | nullYes
titlestring | nullYes
bodystring | nullYes
urlstring | nullYes
image_urlstring | nullYes
datamap<string, string>Yes
readbooleanYes
read_atstring | nullYes
archived_atstring | nullYes
expires_atstring | nullYes
created_atstringYes

Example response:

{
  "url": "https://pushizo.com/orders/1001",
  "data": {
    "order_id": "1001"
  },
  "id": "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "title": "Siparişiniz yola çıktı",
  "body": "Takip bağlantısı içeride",
  "image_url": "https://pushizo.com/orders/1001",
  "read": true,
  "read_at": "örnek",
  "archived_at": "örnek",
  "expires_at": "örnek",
  "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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox/inb_01JD3W5Q7X9K2M4N6P8R0T1V3W/read" \
  -H "Content-Type: application/json" \
  -d '{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "identity_hash": "3f6c…b1e9",
  "token_hash": "sha256-hex…"
}'

Content card feed (in pinned, priority, newest order; the subscription must belong to the user)

GET/sdk/v1/apps/{appId}/users/{userId}/cardsTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
userIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
subscription_idquerystringYesLength: 1–64"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
identity_hashquerystringNoLength: 0–128"3f6c…b1e9"
token_hashquerystringNo"sha256-hex…"
limitqueryintegerNoRange: 1–10050

Responses

200 — Success.

Schema: ContentCardList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].message_idstring | nullYes
data[].typeenumYesValues: "classic", "captioned_image", "image_only"
data[].titlestring | nullYes
data[].bodystring | nullYes
data[].urlstring | nullYes
data[].image_urlstring | nullYes
data[].button_textstring | nullYes
data[].datamap<string, string>Yes
data[].pinnedbooleanYes
data[].priorityintegerYes
data[].viewedbooleanYes
data[].clickedbooleanYes
data[].expires_atstring | nullYes
data[].created_atstringYes
unviewed_countintegerYes

Example response:

{
  "data": [
    {
      "url": "https://pushizo.com/orders/1001",
      "data": {
        "order_id": "1001"
      },
      "type": "classic",
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "title": "Siparişiniz yola çıktı",
      "body": "Takip bağlantısı içeride",
      "image_url": "https://pushizo.com/orders/1001",
      "button_text": "örnek",
      "pinned": true,
      "priority": 10,
      "viewed": true,
      "clicked": true,
      "expires_at": "örnek",
      "created_at": "örnek"
    }
  ],
  "unviewed_count": 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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/cards?subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W&limit=50"

Card event: impression, click or dismiss

POST/sdk/v1/apps/{appId}/users/{userId}/cards/{itemId}/{event}Try it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
userIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
itemIdpathstringYes"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
eventpathstringYes"purchase"

Request body (required)

Schema: SdkInboxActionDto

FieldTypeRequiredDescription
subscription_idstringYesLength: 1–64
identity_hashstringNoLength: 0–128
token_hashstringNo

Example:

{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "identity_hash": "3f6c…b1e9",
  "token_hash": "sha256-hex…"
}

Responses

200 — Success.

Schema: ContentCard

FieldTypeRequiredDescription
idstringYes
message_idstring | nullYes
typeenumYesValues: "classic", "captioned_image", "image_only"
titlestring | nullYes
bodystring | nullYes
urlstring | nullYes
image_urlstring | nullYes
button_textstring | nullYes
datamap<string, string>Yes
pinnedbooleanYes
priorityintegerYes
viewedbooleanYes
clickedbooleanYes
expires_atstring | nullYes
created_atstringYes

Example response:

{
  "url": "https://pushizo.com/orders/1001",
  "data": {
    "order_id": "1001"
  },
  "type": "classic",
  "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "title": "Siparişiniz yola çıktı",
  "body": "Takip bağlantısı içeride",
  "image_url": "https://pushizo.com/orders/1001",
  "button_text": "örnek",
  "pinned": true,
  "priority": 10,
  "viewed": true,
  "clicked": true,
  "expires_at": "örnek",
  "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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/cards/inb_01JD3W5Q7X9K2M4N6P8R0T1V3W/purchase" \
  -H "Content-Type: application/json" \
  -d '{
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "identity_hash": "3f6c…b1e9",
  "token_hash": "sha256-hex…"
}'

Remove from inbox (archive)

DELETE/sdk/v1/apps/{appId}/users/{userId}/inbox/{itemId}Try it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
userIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
itemIdpathstringYes"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
subscription_idquerystringYesLength: 1–64"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
identity_hashquerystringNoLength: 0–128"3f6c…b1e9"
token_hashquerystringNo"sha256-hex…"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

curl -X DELETE "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox/inb_01JD3W5Q7X9K2M4N6P8R0T1V3W?subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"

The device user's preferences and categories

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
subscription_idquerystringYesLength: 1–64"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
token_hashquerystringNo"sha256-hex…"
identity_hashquerystringNoLength: 64–64"3f6c…b1e9"

Responses

200 — Success.

Schema: SdkPreferences

FieldTypeRequiredDescription
dataarray<object>Yes
data[].categorystringYes
data[].channelstring | nullYes
data[].opted_inbooleanYes
data[].explicitbooleanYes
data[].sourcestring | nullYes
data[].updated_atstring | nullYes
categoriesarray<object>Yes
categories[].keystringYes
categories[].namemap<string, string>Yes
categories[].descriptionmap<string, string>Yes
categories[].channelsarray<string> | nullYes
categories[].default_opted_inbooleanYes
consentsarray<object>Yes
consents[].purposeenumYesValues: "ads_personalization"
consents[].grantedbooleanYes
consents[].sourcestring | nullYes
consents[].updated_atstring | nullYes

Example response:

{
  "data": [
    {
      "channel": "web_push",
      "category": "örnek",
      "opted_in": true,
      "explicit": true,
      "source": "örnek",
      "updated_at": "örnek"
    }
  ],
  "categories": [
    {
      "name": {
        "key": "user_42"
      },
      "channels": [
        "web_push"
      ],
      "key": "key-2026-10",
      "description": {
        "key": "user_42"
      },
      "default_opted_in": true
    }
  ],
  "consents": [
    {
      "purpose": "ads_personalization",
      "granted": true,
      "source": "ö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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/preferences?subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Write the device user's preferences

PUT/sdk/v1/apps/{appId}/preferencesTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkSetPreferencesDto

FieldTypeRequiredDescription
preferencesarray<object>YesItems: 1–100
preferences[].categorystringYesLength: 1–64
preferences[].channelenum | nullNo
preferences[].opted_inbooleanYes
subscription_idstringYesLength: 1–64
token_hashstringNo
identity_hashstringNoLength: 64–64

Example:

{
  "preferences": [
    {
      "category": "örnek",
      "opted_in": true,
      "channel": "ios_push"
    }
  ],
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}

Responses

200 — Success.

Schema: SdkPreferences

FieldTypeRequiredDescription
dataarray<object>Yes
data[].categorystringYes
data[].channelstring | nullYes
data[].opted_inbooleanYes
data[].explicitbooleanYes
data[].sourcestring | nullYes
data[].updated_atstring | nullYes
categoriesarray<object>Yes
categories[].keystringYes
categories[].namemap<string, string>Yes
categories[].descriptionmap<string, string>Yes
categories[].channelsarray<string> | nullYes
categories[].default_opted_inbooleanYes
consentsarray<object>Yes
consents[].purposeenumYesValues: "ads_personalization"
consents[].grantedbooleanYes
consents[].sourcestring | nullYes
consents[].updated_atstring | nullYes

Example response:

{
  "data": [
    {
      "channel": "web_push",
      "category": "örnek",
      "opted_in": true,
      "explicit": true,
      "source": "örnek",
      "updated_at": "örnek"
    }
  ],
  "categories": [
    {
      "name": {
        "key": "user_42"
      },
      "channels": [
        "web_push"
      ],
      "key": "key-2026-10",
      "description": {
        "key": "user_42"
      },
      "default_opted_in": true
    }
  ],
  "consents": [
    {
      "purpose": "ads_personalization",
      "granted": true,
      "source": "ö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 PUT "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/preferences" \
  -H "Content-Type: application/json" \
  -d '{
  "preferences": [
    {
      "category": "örnek",
      "opted_in": true,
      "channel": "ios_push"
    }
  ],
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9"
}'

Attribution touches (UTM, fbclid/gclid/ttclid…); proof of ownership same as for events

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

touch_id is unique (retries do not create duplicate records). landing_url is stored as origin + path only.

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkAttributionDto

FieldTypeRequiredDescription
subscription_idstringNoLength: 1–64
token_hashstringNo
identity_hashstringNoLength: 64–64
external_idstringNoLength: 1–128
touchesarray<object>YesItems: 1–10
touches[].touch_idstringYesLength: 8–64
touches[].occurred_atstring (date-time)Yes
touches[].utm_sourcestringNoLength: 1–200
touches[].utm_mediumstringNoLength: 1–200
touches[].utm_campaignstringNoLength: 1–200
touches[].utm_termstringNoLength: 1–200
touches[].utm_contentstringNoLength: 1–200
touches[].utm_idstringNoLength: 1–200
touches[].click_id_typeenumNoValues: "fbclid", "gclid", "gbraid", "wbraid", "ttclid", "li_fat_id", "msclkid"
touches[].click_idstringNoLength: 1–500
touches[].landing_urlstringNoLength: 0–2000
touches[].referrerstringNoLength: 0–255

Example:

{
  "touches": [
    {
      "touch_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "occurred_at": "2026-10-17T09:00:00Z",
      "utm_source": "örnek",
      "utm_medium": "örnek",
      "utm_campaign": "örnek"
    }
  ],
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9",
  "external_id": "user_42"
}

Responses

200 — Success.

Schema: SdkAttributionAccepted

FieldTypeRequiredDescription
acceptedintegerYes

Example response:

{
  "accepted": 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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/attribution" \
  -H "Content-Type: application/json" \
  -d '{
  "touches": [
    {
      "touch_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "occurred_at": "2026-10-17T09:00:00Z",
      "utm_source": "örnek",
      "utm_medium": "örnek",
      "utm_campaign": "örnek"
    }
  ],
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9",
  "external_id": "user_42"
}'

Published web campaigns (trigger/condition/frequency are evaluated in the SDK). ETag and 60 s cache: publishing changes are reflected within 1 minute at most.

GET/sdk/v1/apps/{appId}/web-campaignsTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
subscription_idquerystringNoLength: 1–64"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
token_hashquerystringNo"sha256-hex…"
languagequerystringNoLength: 2–10"tr"

Responses

200 — Success.

Schema: SdkWebCampaignList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].priorityintegerYes
data[].triggerobjectYes
data[].conditionsobjectYes
data[].conditions.url_rulesarray<object>NoItems: 0–10
data[].conditions.utm_rulesarray<object>NoItems: 0–5
data[].conditions.visitsobjectNo
data[].targetingobjectYes
data[].targeting.visitorenumYesValues: "all", "new", "returning"
data[].targeting.devicesarray<enum>Yes
data[].frequencyobjectYes
data[].frequency.max_per_sessionintegerNoRange: 1–100
data[].frequency.max_per_dayintegerNoRange: 1–100
data[].frequency.max_totalintegerNoRange: 1–1000
data[].frequency.hide_after_close_daysintegerNoRange: 0–365
data[].frequency.stop_after_conversionbooleanNo
data[].displayobjectYes
data[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
data[].display.positionenumYesValues: "left", "right"
data[].display.background_colorstring | nullYes
data[].display.text_colorstring | nullYes
data[].display.dismissiblebooleanYes
data[].display.auto_dismiss_secondsinteger | nullYes
data[].display.max_widthinteger | nullYes
data[].display.blocksarray<object>Yes
data[].display.form_idstring | nullYes
data[].display.survey_idstring | nullYes
data[].variantsarray<object>Yes
data[].variants[].idstringYes
data[].variants[].weight_percentintegerYes
data[].variants[].displayobjectYes
data[].end_atstring | nullYes
formsmap<string, object>Yes
surveysmap<string, object>Yes
languagestringYes

Example response:

{
  "data": [
    {
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "priority": 10,
      "trigger": {
        "kind": "page_load",
        "delay_seconds": 1
      },
      "conditions": {
        "url_rules": [
          {}
        ],
        "utm_rules": [
          {}
        ]
      },
      "targeting": {
        "visitor": "all",
        "devices": [
          "desktop"
        ]
      },
      "frequency": {
        "max_per_session": 1,
        "max_per_day": 1
      },
      "display": {
        "layout": "popup",
        "position": "left",
        "background_color": "örnek",
        "text_color": "örnek",
        "dismissible": true,
        "auto_dismiss_seconds": 1,
        "max_width": 1,
        "blocks": [
          {}
        ],
        "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "survey_id": "srv_01JD3W5Q7X9K2M4N6P8R0T1V3W"
      },
      "variants": [
        {
          "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "weight_percent": 1,
          "display": {}
        }
      ],
      "end_at": "örnek"
    }
  ],
  "forms": {
    "key": {
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "fields": [
        {
          "type": "email",
          "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "label": "external_id",
          "placeholder": "örnek",
          "required": true,
          "options": [],
          "max_length": 1,
          "policy_url": "https://pushizo.com/orders/1001"
        }
      ],
      "submit_label": "örnek",
      "success_message": "örnek"
    }
  },
  "surveys": {
    "key": {
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "questions": [
        {
          "type": "nps",
          "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "text": "Takip bağlantısı içeride",
          "required": true,
          "options": [],
          "low_label": "örnek",
          "high_label": "örnek",
          "placeholder": "örnek"
        }
      ],
      "submit_label": "örnek",
      "thank_you": "örnek"
    }
  },
  "language": "tr"
}

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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-campaigns"

Web campaign impression / click / dismiss / conversion

POST/sdk/v1/apps/{appId}/web-campaigns/{campaignId}/eventsTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkWebCampaignEventDto

FieldTypeRequiredDescription
typeenumYesValues: "impression", "click", "close", "conversion"
visitor_idstringYes
variant_idstringNoLength: 0–64
button_idstringNoLength: 0–64
subscription_idstringNoLength: 1–64
token_hashstringNo

Example:

{
  "type": "impression",
  "visitor_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "button_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…"
}

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/events" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "impression",
  "visitor_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "button_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…"
}'

Form submission: creates or links a user/subscription, records consent, emits a journey event

POST/sdk/v1/apps/{appId}/forms/{formId}/submissionsTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
formIdpathstringYes"frm_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkFormSubmitDto

FieldTypeRequiredDescription
valuesmap<string, string | boolean | number | array<string>>Yes
visitor_idstringNo
subscription_idstringNoLength: 1–64
token_hashstringNo
identity_hashstringNoLength: 64–64
web_campaign_idstringNoLength: 0–64
page_urlstringNoLength: 0–2000
languagestringNoLength: 2–10
websitestringNoLength: 0–500
elapsed_msintegerNoRange: 0–86400000

Example:

{
  "values": {
    "key": "user_42"
  },
  "visitor_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9",
  "web_campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}

Responses

200 — Success.

Schema: FormSubmitResult

FieldTypeRequiredDescription
oktrueYes
statusenumYesValues: "accepted", "pending_confirmation"
submission_idstring | nullYes
success_messagestringYes
redirect_urlstring | nullYes

Example response:

{
  "status": "accepted",
  "ok": true,
  "submission_id": "fsb_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "success_message": "örnek",
  "redirect_url": "https://pushizo.com/orders/1001"
}

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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/forms/frm_01JD3W5Q7X9K2M4N6P8R0T1V3W/submissions" \
  -H "Content-Type: application/json" \
  -d '{
  "values": {
    "key": "user_42"
  },
  "visitor_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "identity_hash": "3f6c…b1e9",
  "web_campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'

Survey response (web pop-up or native in-app UI)

POST/sdk/v1/apps/{appId}/surveys/{surveyId}/responsesTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
surveyIdpathstringYes"srv_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkSurveyResponseDto

FieldTypeRequiredDescription
answersmap<string, string | boolean | number | array<string>>Yes
visitor_idstringNo
subscription_idstringNoLength: 1–64
token_hashstringNo
web_campaign_idstringNoLength: 0–64

Example:

{
  "answers": {
    "key": "user_42"
  },
  "visitor_id": "srs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "web_campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}

Responses

200 — Success.

Schema: SurveyResponseResult

FieldTypeRequiredDescription
oktrueYes
response_idstring | nullYes
duplicatebooleanYes
thank_youstringYes

Example response:

{
  "ok": true,
  "response_id": "srs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "duplicate": true,
  "thank_you": "ö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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/surveys/srv_01JD3W5Q7X9K2M4N6P8R0T1V3W/responses" \
  -H "Content-Type: application/json" \
  -d '{
  "answers": {
    "key": "user_42"
  },
  "visitor_id": "srs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…",
  "web_campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'

Published personalization experiences (conditions/variants are evaluated in the SDK). ETag and 60 s cache.

GET/sdk/v1/apps/{appId}/web-personalizationsTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
subscription_idquerystringNoLength: 1–64"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
token_hashquerystringNo"sha256-hex…"
languagequerystringNoLength: 2–10"tr"

Responses

200 — Success.

Schema: SdkWebPersonalizationList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].priorityintegerYes
data[].conditionsobjectYes
data[].conditions.url_rulesarray<object>NoItems: 0–10
data[].conditions.utm_rulesarray<object>NoItems: 0–5
data[].conditions.visitsobjectNo
data[].targetingobjectYes
data[].targeting.visitorenumYesValues: "all", "new", "returning"
data[].targeting.devicesarray<enum>Yes
data[].changesarray<object>Yes
data[].changes[].selectorstringYes
data[].changes[].actionenumYesValues: "text", "image", "link", "hide", "show"
data[].changes[].textstring | nullYes
data[].changes[].urlstring | nullYes
data[].changes[].altstring | nullYes
data[].changes[].new_tabbooleanYes
data[].variantsarray<object>Yes
data[].variants[].idstringYes
data[].variants[].weight_percentintegerYes
data[].variants[].changesarray<object>Yes
data[].winner_variant_idstring | nullYes
data[].goalobject | nullYes
data[].end_atstring | nullYes
editor_originsarray<string>Yes
languagestringYes

Example response:

{
  "data": [
    {
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "priority": 10,
      "conditions": {
        "url_rules": [
          {}
        ],
        "utm_rules": [
          {}
        ]
      },
      "targeting": {
        "visitor": "all",
        "devices": [
          "desktop"
        ]
      },
      "changes": [
        {
          "url": "https://pushizo.com/orders/1001",
          "selector": "örnek",
          "action": "text",
          "text": "Takip bağlantısı içeride",
          "alt": "örnek",
          "new_tab": true
        }
      ],
      "variants": [
        {
          "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "weight_percent": 1,
          "changes": []
        }
      ],
      "winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "goal": {
        "type": "event",
        "event": "purchase"
      },
      "end_at": "örnek"
    }
  ],
  "editor_origins": [
    "örnek"
  ],
  "language": "tr"
}

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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations"

Personalization exposure / conversion event

POST/sdk/v1/apps/{appId}/web-personalizations/{personalizationId}/eventsTry it (interactive API docs, new tab)

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
personalizationIdpathstringYes"wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SdkWebPersonalizationEventDto

FieldTypeRequiredDescription
typeenumYesValues: "impression", "conversion"
visitor_idstringYes
variant_idstringNoLength: 0–64
subscription_idstringNoLength: 1–64
token_hashstringNo

Example:

{
  "type": "impression",
  "visitor_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…"
}

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations/wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W/events" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "impression",
  "visitor_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token_hash": "sha256-hex…"
}'

Site search: results and (with mode=answer) an AI answer with sources from the site's own content. If an AI answer cannot be given, only results are returned.

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SiteSearchRequestDto

FieldTypeRequiredDescription
querystringYesLength: 0–1000
modeenumNoValues: "search", "answer"
languagestringNo
limitintegerNoRange: 1–20

Example:

{
  "query": "ayse",
  "mode": "search",
  "language": "tr",
  "limit": 50
}

Responses

200 — Success.

Schema: SiteSearchResponse

FieldTypeRequiredDescription
query_idstringYes
modeenumYesValues: "search", "answer"
resultsarray<object>Yes
results[].idstringYes
results[].urlstringYes
results[].titlestringYes
results[].headingstringYes
results[].snippetstringYes
results[].snippet_htmlstringYes
answerobject | nullYes
answer_statusenum | nullYes
answers_availablebooleanYes

Example response:

{
  "query_id": "srs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "mode": "search",
  "results": [
    {
      "url": "https://pushizo.com/orders/1001",
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "title": "Siparişiniz yola çıktı",
      "heading": "Siparişiniz yola çıktı",
      "snippet": "örnek",
      "snippet_html": "örnek"
    }
  ],
  "answer": {
    "text": "Takip bağlantısı içeride",
    "sources": [
      {
        "url": "https://pushizo.com/orders/1001",
        "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "title": "Siparişiniz yola çıktı"
      }
    ]
  },
  "answer_status": "answered",
  "answers_available": 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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/search" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "ayse",
  "mode": "search",
  "language": "tr",
  "limit": 50
}'

Search event: clicked result

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

Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SiteSearchEventDto

FieldTypeRequiredDescription
query_idstringYesLength: 0–60
typeenumYesValues: "click"
urlstringYesLength: 0–2000
positionintegerNoRange: 1–100

Example:

{
  "url": "https://pushizo.com/orders/1001",
  "type": "click",
  "query_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "position": 1
}

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

curl -X POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/search/events" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://pushizo.com/orders/1001",
  "type": "click",
  "query_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "position": 1
}'

On this page

OperationsDetailsPublic app configuration for the SDK200 — Success.Device/channel registration (idempotent: the same token yields a single subscription)200 — Success.Token refresh, device info, opt-in/out (proof of ownership: token_hash or identity_hash)200 — Success.Delete a subscription (proof of ownership: token_hash or identity_hash)200 — Success.Link the device to a user by external_id (the anonymous user is merged; proof of ownership: token_hash)200 — Success.Move the device to a new anonymous user (proof of ownership: token_hash or identity_hash)200 — Success.Tag/property merge-patch (a hash is required if identity verification is enforced)200 — Success.Add an alias to the user (User.addAlias; hash required if identity verification is enforced)200 — Success.Remove an alias from the user (User.removeAlias)200 — Success.Session start (without duration) or end (with duration; proof of ownership: token_hash or identity_hash)200 — Success.Evaluate feature flags200 — Success.Nearest geofences for the device to monitor200 — Success.Geofence transitions reported by the operating system200 — Success.Bulk event reporting (up to 100)200 — Success.Device received the notification (confirmed delivery)200 — Success.Notification dismissed by the user (web notificationclose, Android swipe-away)200 — Success.Notification opened / button clicked200 — Success.Register a Live Activity token (push-to-start or activity update)200 — Success.Delete a Live Activity token (activity ended or permission revoked)200 — Success.SDK error reports (up to 20; retained for 7 days)200 — Success.Chat widget settings (color, position, texts), online/business hours status and attachment limits200 — Success.Link the visitor to a user (external_id + identity_hash/JWT) and/or a push subscription (token_hash)200 — Success.The visitor's conversation and unread message count (null if none yet)200 — Success.Messages: missing ones with after_seq (oldest first), history with before_seq; sequence-numbered200 — Success.Send a message (deduplicated by client_message_id; the first message opens the conversation)200 — Success.Send a file/image attachment (multipart: file + visitor_id, visitor_token, client_message_id, text; up to 10 MB)200 — Success.Attachment file (only from this visitor's conversation; download with ?download=true)200 — Success.Visitor typing indicator (real time to agents)200 — Success.Read / delivered receipt (sequence number; only moves forward)200 — Success.Leave a message and email when offline / outside business hours200 — Success.Live chat stream (Server-Sent Events)200 — Success.In-app messages that can be shown on the device (triggers are evaluated by the SDK)200 — Success.Embedded placement content200 — Success.In-app impression / click / dismiss200 — Success.Notification inbox (the subscription must belong to the user; identity_hash if required)200 — Success.Mark all as read200 — Success.Mark as read200 — Success.Content card feed (in pinned, priority, newest order; the subscription must belong to the user)200 — Success.Card event: impression, click or dismiss200 — Success.Remove from inbox (archive)200 — Success.The device user's preferences and categories200 — Success.Write the device user's preferences200 — Success.Attribution touches (UTM, fbclid/gclid/ttclid…); proof of ownership same as for events200 — Success.Published web campaigns (trigger/condition/frequency are evaluated in the SDK). ETag and 60 s cache: publishing changes are reflected within 1 minute at most.200 — Success.Web campaign impression / click / dismiss / conversion200 — Success.Form submission: creates or links a user/subscription, records consent, emits a journey event200 — Success.Survey response (web pop-up or native in-app UI)200 — Success.Published personalization experiences (conditions/variants are evaluated in the SDK). ETag and 60 s cache.200 — Success.Personalization exposure / conversion event200 — Success.Site search: results and (with mode=answer) an AI answer with sources from the site's own content. If an AI answer cannot be given, only results are returned.200 — Success.Search event: clicked result200 — Success.