PushizoDocs
API reference

Notifications

Notifications — 9 operations (GET /v1/notifications, POST /v1/notifications, POST /v1/notifications/estimate, …). Generated from the OpenAPI 3.1.0 contract.

One-off message sending (202, asynchronous delivery), status/cancel, recipient estimate, delivery list, message history and event export. Idempotency-Key is supported.

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

Operations

Details

List messages (app_id required)

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

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
app_idquerystringNo"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
sourcequeryenumNoValues: "campaign", "api", "journey", "test""campaign"
kindqueryenumNoValues: "campaign", "api", "journey", "test""campaign"
statusqueryenumNoValues: "queued", "processing", "completed", "cancelled", "failed""queued"
sortqueryenumNoValues: "created_at", "-created_at""created_at"
labelquerystringNoLength: 1–40"external_id"

Responses

200 — Success.

Schema: MessageList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].sourceenumYesValues: "campaign", "api", "journey", "test"
data[].statusenumYesValues: "queued", "processing", "completed", "cancelled", "failed"
data[].idempotency_keystring | nullYes
data[].namestring | nullYes
data[].contentmap<string, any>Yes
data[].targetmap<string, any>Yes
data[].optionsmap<string, any>Yes
data[].labelsarray<string>Yes
data[].categorystring | nullYes
data[].template_idstring | nullYes
data[].campaign_idstring | nullYes
data[].variantsarray<object> | nullYes
data[].countsobjectYes
data[].counts.targetedintegerNo
data[].counts.suppressedintegerNo
data[].counts.sentintegerNo
data[].counts.deliveredintegerNo
data[].counts.failedintegerNo
data[].counts.erroredintegerNo
data[].counts.expiredintegerNo
data[].counts.openedintegerNo
data[].counts.clickedintegerNo
data[].counts.convertedintegerNo
data[].counts.bouncedintegerNo
data[].counts.complainedintegerNo
data[].counts.unsubscribedintegerNo
data[].counts.sms_segmentsintegerNo
data[].requested_byobjectYes
data[].requested_by.typeenumYesValues: "api_key", "account", "system"
data[].requested_by.idstringNo
data[].errorstring | nullYes
data[].scheduled_forstring | nullYes
data[].started_atstring | nullYes
data[].completed_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "target": {
        "include_external_ids": [
          "user_42"
        ]
      },
      "status": "queued",
      "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "source": "campaign",
      "idempotency_key": "order-1001",
      "content": {
        "contents": {
          "tr": "Siparişiniz yola çıktı"
        }
      },
      "options": {},
      "labels": [
        "promo"
      ],
      "category": "örnek",
      "template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "variants": [
        {
          "name": "Sipariş bildirimleri",
          "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "weight_percent": 1,
          "is_control": true
        }
      ],
      "counts": {
        "targeted": 1,
        "suppressed": 1
      },
      "requested_by": {
        "type": "api_key",
        "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
      },
      "error": "örnek",
      "scheduled_for": "örnek",
      "started_at": "örnek",
      "completed_at": "örnek",
      "created_at": "örnek",
      "updated_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

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

Examples

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

Create a notification (202, asynchronous delivery)

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

Parameters

NameInTypeRequiredDescriptionExample
Idempotency-KeyheaderstringNoA request repeated with the same key within 24 hours returns the same message (equivalent to idempotency_key in the body)."order-1001"

Request body (required)

Schema: CreateNotificationDto

FieldTypeRequiredDescription
app_idstringNoLength: 1–∞
idempotency_keystringNoLength: 1–255
targetobjectYes
target.allbooleanNo
target.include_subscription_idsarray<string>NoItems: 0–2000
target.include_external_idsarray<string>NoItems: 0–2000
target.include_aliasesmap<string, array<string>>No
target.included_segmentsarray<string>NoItems: 0–50
target.excluded_segmentsarray<string>NoItems: 0–50
target.filtersanyNo
target.channelsarray<enum>NoItems: 1–∞
target.test_devices_onlybooleanNo
target.email_toarray<string>NoItems: 1–2000
target.include_phone_numbersarray<string>NoItems: 1–2000
headingsmap<string, string>No
contentsmap<string, string>No
subtitlemap<string, string>No
urlstring (url)NoLength: 0–2000
app_urlstring (url)NoLength: 0–2000
datamap<string, string>No
buttonsarray<object>NoItems: 0–3
buttons[].idstringYesLength: 1–64
buttons[].textstringYesLength: 1–100
buttons[].iconstring (url)NoLength: 0–2000
buttons[].urlstring (url)NoLength: 0–2000
big_picturestring (url)NoLength: 0–2000
ios_attachmentsmap<string, string (url)>No
ios_soundstringNoLength: 0–100
ios_badge_typeenumNoValues: "None", "SetTo", "Increase"
ios_badge_countintegerNoRange: 0–99999
ios_interruption_levelenumNoValues: "passive", "active", "time-sensitive", "critical"
ios_categorystringNoLength: 0–100
thread_idstringNoLength: 0–100
ios_relevance_scorenumberNoRange: 0–1
target_content_identifierstringNoLength: 0–200
android_channel_idstringNoLength: 0–100
android_groupstringNoLength: 0–100
android_soundstringNoLength: 0–100
small_iconstringNoLength: 0–100
large_iconstring (url) | stringNo
android_accent_colorstringNo
android_visibility1 | 0 | -1No
ios_carouselarray<object>NoItems: 0–5
ios_carousel[].urlstring (url)YesLength: 0–2000
ios_carousel[].titlestringNoLength: 0–80
android_live_updateobjectNo
android_live_update.progressintegerYesRange: 0–100
android_live_update.ongoingbooleanNo
voipbooleanNo
app_clipbooleanNo
chrome_web_iconstring (url)NoLength: 0–2000
chrome_web_imagestring (url)NoLength: 0–2000
chrome_web_badgestring (url)NoLength: 0–2000
web_push_topicstringNoLength: 0–32
web_buttonsarray<object>NoItems: 0–2
web_buttons[].idstringYesLength: 1–64
web_buttons[].textstringYesLength: 1–100
web_buttons[].iconstring (url)NoLength: 0–2000
web_buttons[].urlstring (url)NoLength: 0–2000
require_interactionbooleanNo
content_availablebooleanNo
mutable_contentbooleanNo
collapse_idstringNoLength: 0–64
priority5 | 10No
ttlintegerNoRange: 60–2419200
send_afterstring (date-time)No
delayed_optionenumNoValues: "timezone", "optimized"
delivery_time_of_daystringNo
template_idstringNo
custom_datamap<string, any>No
email_subjectstringNoLength: 0–998
email_bodystringNoLength: 0–500000
email_mjmlstringNoLength: 0–500000
email_preheaderstringNoLength: 0–500
email_from_namestringNoLength: 0–200
email_from_addressstring (email)NoLength: 0–320
email_reply_to_addressstring (email)NoLength: 0–320
disable_email_click_trackingbooleanNo
sms_fromstringNoLength: 1–20
sms_media_urlsarray<string (url)>NoItems: 1–10
disable_sms_link_shorteningbooleanNo
whatsapp_templateobjectNo
whatsapp_template.namestringYes
whatsapp_template.languagestringYes
whatsapp_template.headerobjectNo
whatsapp_template.body_paramsarray<string>NoItems: 0–20
whatsapp_template.button_paramsarray<object>NoItems: 0–10
whatsapp_template.button_params[].indexintegerYesRange: 0–9
whatsapp_template.button_params[].sub_typeenumYesValues: "url", "quick_reply", "copy_code"
whatsapp_template.button_params[].valuestringYesLength: 1–256
whatsapp_mediaobjectNo
whatsapp_media.typeenumYesValues: "image", "video", "document", "audio"
whatsapp_media.urlstring (url)YesLength: 0–2000
whatsapp_media.filenamestringNoLength: 1–240
whatsapp_interactiveobjectNo
whatsapp_interactive.typeenumYesValues: "button", "list"
whatsapp_interactive.headerstringNoLength: 1–60
whatsapp_interactive.footerstringNoLength: 1–60
whatsapp_interactive.buttonsarray<object>NoItems: 1–3
whatsapp_interactive.buttons[].idstringYesLength: 1–256
whatsapp_interactive.buttons[].titlestringYesLength: 1–20
whatsapp_interactive.listobjectNo
whatsapp_interactive.list.buttonstringYesLength: 1–20
whatsapp_interactive.list.sectionsarray<object>YesItems: 1–10
whatsapp_interactive.list.sections[].titlestringNoLength: 1–24
whatsapp_interactive.list.sections[].rowsarray<object>YesItems: 1–10
whatsapp_interactive.list.sections[].rows[].idstringYesLength: 1–200
whatsapp_interactive.list.sections[].rows[].titlestringYesLength: 1–24
whatsapp_interactive.list.sections[].rows[].descriptionstringNoLength: 1–72
rcs_cardobjectNo
rcs_card.titlemap<string, string>No
rcs_card.descriptionmap<string, string>No
rcs_card.media_urlstring (url)NoLength: 0–2000
rcs_card.media_heightenumNoValues: "SHORT", "MEDIUM", "TALL"
rcs_card.orientationenumNoValues: "VERTICAL", "HORIZONTAL"
rcs_suggestionsarray<object>NoItems: 0–11
rcs_content_sidstringNo
rcs_content_variablesmap<string, string>No
rcs_fallback_textmap<string, string>No
messenger_image_urlstring (url)NoLength: 0–2000
messenger_buttonsarray<object>NoItems: 0–6
add_to_inboxbooleanNo
inbox_ttlintegerNoRange: 60–31536000
content_cardobjectNo
content_card.typeenumYesValues: "classic", "captioned_image", "image_only"
content_card.pinnedbooleanNo
content_card.priorityintegerNoRange: 0–100
content_card.button_textmap<string, string>No
frequency_cap_exemptbooleanNo
quiet_hours_exemptbooleanNo
one_per_userbooleanNo
throttle_rate_per_minuteintegerNoRange: 0–1000000
include_unsubscribedbooleanNo
namestringNoLength: 1–200
labelsarray<string>NoItems: 0–10
categorystringNoLength: 1–64
fallback_channelenumNoValues: "sms", "email"
form_factorenumNoValues: "phone", "watch"

Example:

{
  "target": {
    "include_external_ids": [
      "user_42"
    ],
    "channels": [
      "ios_push"
    ],
    "all": false
  },
  "name": "Sipariş bildirimleri",
  "headings": {
    "tr": "Siparişiniz yola çıktı",
    "en": "Your order has shipped"
  },
  "contents": {
    "tr": "Siparişiniz yola çıktı",
    "en": "Your order has shipped"
  },
  "url": "https://pushizo.com/orders/1001",
  "data": {
    "order_id": "1001"
  }
}

Responses

202 — Success.

Schema: CreateNotificationResult

FieldTypeRequiredDescription
idstringYes
statusenumYesValues: "queued", "processing", "completed", "cancelled", "failed"
recipients_estimateintegerYes
external_id_missingarray<string>Yes

Example response:

{
  "status": "queued",
  "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "recipients_estimate": 1,
  "external_id_missing": [
    "örnek"
  ]
}

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

Examples

curl -X POST "https://api.pushizo.com/v1/notifications" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Idempotency-Key: order-1001" \
  -H "Content-Type: application/json" \
  -d '{
  "target": {
    "include_external_ids": [
      "user_42"
    ],
    "channels": [
      "ios_push"
    ],
    "all": false
  },
  "name": "Sipariş bildirimleri",
  "headings": {
    "tr": "Siparişiniz yola çıktı",
    "en": "Your order has shipped"
  },
  "contents": {
    "tr": "Siparişiniz yola çıktı",
    "en": "Your order has shipped"
  },
  "url": "https://pushizo.com/orders/1001",
  "data": {
    "order_id": "1001"
  }
}'

Recipient count for an unsaved target (does not send)

POST/v1/notifications/estimateTry it (interactive API docs, new tab)

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

Request body (required)

Schema: EstimateAudienceDto

FieldTypeRequiredDescription
app_idstringNoLength: 1–∞
targetobjectYes
target.allbooleanNo
target.include_subscription_idsarray<string>NoItems: 0–2000
target.include_external_idsarray<string>NoItems: 0–2000
target.include_aliasesmap<string, array<string>>No
target.included_segmentsarray<string>NoItems: 0–50
target.excluded_segmentsarray<string>NoItems: 0–50
target.filtersanyNo
target.channelsarray<enum>NoItems: 1–∞
target.test_devices_onlybooleanNo
target.email_toarray<string>NoItems: 1–2000
target.include_phone_numbersarray<string>NoItems: 1–2000
include_unsubscribedbooleanNo

Example:

{
  "target": {
    "include_external_ids": [
      "user_42"
    ],
    "channels": [
      "ios_push"
    ],
    "all": false
  },
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "include_unsubscribed": false
}

Responses

200 — Success.

Schema: EstimateAudienceResult

FieldTypeRequiredDescription
recipientsintegerYes
by_channelmap<string, integer>Yes
new_contactsintegerYes
external_id_missingarray<string>Yes

Example response:

{
  "recipients": 1,
  "by_channel": {
    "key": 150
  },
  "new_contacts": 1,
  "external_id_missing": [
    "örnek"
  ]
}

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

Examples

curl -X POST "https://api.pushizo.com/v1/notifications/estimate" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target": {
    "include_external_ids": [
      "user_42"
    ],
    "channels": [
      "ios_push"
    ],
    "all": false
  },
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "include_unsubscribed": false
}'

Message status and counters

GET/v1/notifications/{messageId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
messageIdpathstringYes"msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
app_idquerystringNo"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Message

FieldTypeRequiredDescription
idstringYes
app_idstringYes
sourceenumYesValues: "campaign", "api", "journey", "test"
statusenumYesValues: "queued", "processing", "completed", "cancelled", "failed"
idempotency_keystring | nullYes
namestring | nullYes
contentmap<string, any>Yes
targetmap<string, any>Yes
optionsmap<string, any>Yes
labelsarray<string>Yes
categorystring | nullYes
template_idstring | nullYes
campaign_idstring | nullYes
variantsarray<object> | nullYes
countsobjectYes
counts.targetedintegerNo
counts.suppressedintegerNo
counts.sentintegerNo
counts.deliveredintegerNo
counts.failedintegerNo
counts.erroredintegerNo
counts.expiredintegerNo
counts.openedintegerNo
counts.clickedintegerNo
counts.convertedintegerNo
counts.bouncedintegerNo
counts.complainedintegerNo
counts.unsubscribedintegerNo
counts.sms_segmentsintegerNo
requested_byobjectYes
requested_by.typeenumYesValues: "api_key", "account", "system"
requested_by.idstringNo
errorstring | nullYes
scheduled_forstring | nullYes
started_atstring | nullYes
completed_atstring | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "target": {
    "include_external_ids": [
      "user_42"
    ]
  },
  "status": "queued",
  "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "source": "campaign",
  "idempotency_key": "order-1001",
  "content": {
    "contents": {
      "tr": "Siparişiniz yola çıktı"
    }
  },
  "options": {},
  "labels": [
    "promo"
  ],
  "category": "örnek",
  "template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "is_control": true
    }
  ],
  "counts": {
    "targeted": 1,
    "suppressed": 1,
    "sent": 1,
    "delivered": 1
  },
  "requested_by": {
    "type": "api_key",
    "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
  },
  "error": "örnek",
  "scheduled_for": "örnek",
  "started_at": "örnek",
  "completed_at": "örnek",
  "created_at": "örnek",
  "updated_at": "örnek"
}

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

Examples

curl -X GET "https://api.pushizo.com/v1/notifications/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Cancel a scheduled/queued message

DELETE/v1/notifications/{messageId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
messageIdpathstringYes"msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
app_idquerystringNo"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Message

FieldTypeRequiredDescription
idstringYes
app_idstringYes
sourceenumYesValues: "campaign", "api", "journey", "test"
statusenumYesValues: "queued", "processing", "completed", "cancelled", "failed"
idempotency_keystring | nullYes
namestring | nullYes
contentmap<string, any>Yes
targetmap<string, any>Yes
optionsmap<string, any>Yes
labelsarray<string>Yes
categorystring | nullYes
template_idstring | nullYes
campaign_idstring | nullYes
variantsarray<object> | nullYes
countsobjectYes
counts.targetedintegerNo
counts.suppressedintegerNo
counts.sentintegerNo
counts.deliveredintegerNo
counts.failedintegerNo
counts.erroredintegerNo
counts.expiredintegerNo
counts.openedintegerNo
counts.clickedintegerNo
counts.convertedintegerNo
counts.bouncedintegerNo
counts.complainedintegerNo
counts.unsubscribedintegerNo
counts.sms_segmentsintegerNo
requested_byobjectYes
requested_by.typeenumYesValues: "api_key", "account", "system"
requested_by.idstringNo
errorstring | nullYes
scheduled_forstring | nullYes
started_atstring | nullYes
completed_atstring | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "target": {
    "include_external_ids": [
      "user_42"
    ]
  },
  "status": "queued",
  "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "source": "campaign",
  "idempotency_key": "order-1001",
  "content": {
    "contents": {
      "tr": "Siparişiniz yola çıktı"
    }
  },
  "options": {},
  "labels": [
    "promo"
  ],
  "category": "örnek",
  "template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "is_control": true
    }
  ],
  "counts": {
    "targeted": 1,
    "suppressed": 1,
    "sent": 1,
    "delivered": 1
  },
  "requested_by": {
    "type": "api_key",
    "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
  },
  "error": "örnek",
  "scheduled_for": "örnek",
  "started_at": "örnek",
  "completed_at": "örnek",
  "created_at": "örnek",
  "updated_at": "örnek"
}

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

Examples

curl -X DELETE "https://api.pushizo.com/v1/notifications/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Per-subscriber delivery results (cursor)

GET/v1/notifications/{messageId}/deliveriesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
messageIdpathstringYes"msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
app_idquerystringNo"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
statusqueryenumNoValues: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled""pending"

Responses

200 — Success.

Schema: DeliveryList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].message_idstringYes
data[].subscription_idstringYes
data[].user_idstring | nullYes
data[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
data[].providerstring | nullYes
data[].statusenumYesValues: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled"
data[].attempt_countintegerYes
data[].provider_message_idstring | nullYes
data[].error_codestring | nullYes
data[].error_messagestring | nullYes
data[].suppression_reasonstring | nullYes
data[].send_afterstring | nullYes
data[].sent_atstring | nullYes
data[].delivered_atstring | nullYes
data[].opened_atstring | nullYes
data[].clicked_atstring | nullYes
data[].failed_atstring | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "channel": "ios_push",
      "status": "pending",
      "send_after": "örnek",
      "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "provider": "örnek",
      "attempt_count": 1,
      "provider_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "error_code": "örnek",
      "error_message": "örnek",
      "suppression_reason": "örnek",
      "sent_at": "örnek",
      "delivered_at": "örnek",
      "opened_at": "örnek",
      "clicked_at": "örnek",
      "failed_at": "örnek",
      "created_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

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

Examples

curl -X GET "https://api.pushizo.com/v1/notifications/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W/deliveries?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Message trace: msg_/dlv_/sub_ ID, external_id or the last 8 characters of a token

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

Parameters

NameInTypeRequiredDescriptionExample
qquerystringYesLength: 3–255"ayse"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: TraceResult

FieldTypeRequiredDescription
querystringYes
kindstringYes
itemsarray<object>Yes
items[].deliveryobjectYes
items[].delivery.idstringYes
items[].delivery.message_idstringYes
items[].delivery.subscription_idstringYes
items[].delivery.user_idstring | nullYes
items[].delivery.channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
items[].delivery.providerstring | nullYes
items[].delivery.statusenumYesValues: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled"
items[].delivery.attempt_countintegerYes
items[].delivery.provider_message_idstring | nullYes
items[].delivery.error_codestring | nullYes
items[].delivery.error_messagestring | nullYes
items[].delivery.suppression_reasonstring | nullYes
items[].delivery.send_afterstring | nullYes
items[].delivery.sent_atstring | nullYes
items[].delivery.delivered_atstring | nullYes
items[].delivery.opened_atstring | nullYes
items[].delivery.clicked_atstring | nullYes
items[].delivery.failed_atstring | nullYes
items[].delivery.created_atstringYes
items[].eventsarray<object>Yes
items[].events[].idstringYes
items[].events[].typestringYes
items[].events[].detailmap<string, any>Yes
items[].events[].occurred_atstringYes
items[].subscriptionobject | nullYes
items[].userobject | nullYes
items[].renderobject | nullYes
items[].webhooksarray<object>Yes
items[].webhooks[].idstringYes
items[].webhooks[].endpoint_idstringYes
items[].webhooks[].event_typestringYes
items[].webhooks[].statusstringYes
items[].webhooks[].attemptintegerYes
items[].webhooks[].response_statusinteger | nullYes
items[].webhooks[].created_atstringYes
items[].messageobject | nullYes

Example response:

{
  "query": "ayse",
  "kind": "örnek",
  "items": [
    {
      "events": [
        {
          "type": "örnek",
          "id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "detail": {},
          "occurred_at": "örnek"
        }
      ],
      "delivery": {
        "channel": "ios_push",
        "status": "pending",
        "send_after": "örnek",
        "id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "provider": "örnek",
        "attempt_count": 1,
        "provider_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "error_code": "örnek",
        "error_message": "örnek",
        "suppression_reason": "örnek",
        "sent_at": "örnek",
        "delivered_at": "örnek",
        "opened_at": "örnek",
        "clicked_at": "örnek",
        "failed_at": "örnek",
        "created_at": "örnek"
      },
      "subscription": {
        "channel": "ios_push",
        "status": "örnek",
        "id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "token_suffix": "örnek",
        "device": {
          "key": "örnek"
        },
        "test_device": true
      },
      "user": {
        "id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "external_id": "user_42"
      },
      "render": {
        "url": "https://pushizo.com/orders/1001",
        "language": "tr",
        "title": "Siparişiniz yola çıktı",
        "body": "Takip bağlantısı içeride",
        "image_url": "https://pushizo.com/orders/1001",
        "buttons": [
          "örnek"
        ],
        "hash": "örnek",
        "matches_sent": true,
        "error": "örnek"
      },
      "webhooks": [
        {
          "status": "örnek",
          "id": "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "endpoint_id": "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "event_type": "örnek",
          "attempt": 1,
          "response_status": 1,
          "created_at": "örnek"
        }
      ],
      "message": {
        "status": "örnek",
        "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "source": "ö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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/trace?q=ayse" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Notification history CSV job (deliveries; download_url when complete)

GET/v1/notifications/{messageId}/historyTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
messageIdpathstringYes"msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
app_idquerystringNo"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Export

FieldTypeRequiredDescription
idstringYes
app_idstringYes
typeenumYesValues: "users", "subscriptions", "events", "deliveries", "message_events"
filtersobjectYes
filters.fromstring (date-time)No
filters.tostring (date-time)No
filters.namestringNoLength: 0–100
filters.message_idstringNoLength: 0–64
filters.campaign_idstringNoLength: 0–64
filters.statusstringNoLength: 0–32
filters.channelenumNoValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
filters.segment_idstringNoLength: 0–64
statusenumYesValues: "pending", "running", "completed", "failed"
row_countinteger | nullYes
errorstring | nullYes
download_urlstring | nullYes
expires_atstring | nullYes
requested_bystring | nullYes
created_atstringYes
completed_atstring | nullYes

Example response:

{
  "type": "users",
  "status": "pending",
  "id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "filters": {
    "name": "Sipariş bildirimleri",
    "channel": "ios_push",
    "status": "örnek",
    "from": "2026-10-17T09:00:00Z"
  },
  "row_count": 1,
  "error": "örnek",
  "download_url": "https://pushizo.com/orders/1001",
  "expires_at": "örnek",
  "requested_by": "örnek",
  "created_at": "örnek",
  "completed_at": "örnek"
}

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

Examples

curl -X GET "https://api.pushizo.com/v1/notifications/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W/history" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Message event CSV job (sent/delivered/opened/clicked/bounce…; download_url when complete)

POST/v1/notifications/{messageId}/export_eventsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
messageIdpathstringYes"msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
app_idquerystringNo"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

202 — Success.

Schema: Export

FieldTypeRequiredDescription
idstringYes
app_idstringYes
typeenumYesValues: "users", "subscriptions", "events", "deliveries", "message_events"
filtersobjectYes
filters.fromstring (date-time)No
filters.tostring (date-time)No
filters.namestringNoLength: 0–100
filters.message_idstringNoLength: 0–64
filters.campaign_idstringNoLength: 0–64
filters.statusstringNoLength: 0–32
filters.channelenumNoValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
filters.segment_idstringNoLength: 0–64
statusenumYesValues: "pending", "running", "completed", "failed"
row_countinteger | nullYes
errorstring | nullYes
download_urlstring | nullYes
expires_atstring | nullYes
requested_bystring | nullYes
created_atstringYes
completed_atstring | nullYes

Example response:

{
  "type": "users",
  "status": "pending",
  "id": "exp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "filters": {
    "name": "Sipariş bildirimleri",
    "channel": "ios_push",
    "status": "örnek",
    "from": "2026-10-17T09:00:00Z"
  },
  "row_count": 1,
  "error": "örnek",
  "download_url": "https://pushizo.com/orders/1001",
  "expires_at": "örnek",
  "requested_by": "örnek",
  "created_at": "örnek",
  "completed_at": "örnek"
}

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

Examples

curl -X POST "https://api.pushizo.com/v1/notifications/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W/export_events" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

On this page