PushizoDocs
API reference

Channels

Channels — 6 operations (POST /v1/apps/{appId}/messenger-links, GET /v1/apps/{appId}/channels, GET /v1/apps/{appId}/channels/status, …). Generated from the OpenAPI 3.1.0 contract.

APNs, FCM, HMS, Web Push, email and SMS channel configuration; secret fields are stored encrypted and never returned in responses. validate runs a real connection test against the provider.

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

Operations

Details

Telegram/Viber subscription deep link (single-use token; when the user messages the bot, the chat ID is linked to this user as a subscription)

POST/v1/apps/{appId}/messenger-linksTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateMessengerLinkDto

FieldTypeRequiredDescription
channelenumYesValues: "telegram", "viber"
user_idstringNoLength: 1–64
external_idstringNoLength: 1–255
ttl_secondsintegerNoRange: 60–2592000

Example:

{
  "channel": "telegram",
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42",
  "ttl_seconds": 60
}

Responses

201 — Success.

Schema: MessengerLink

FieldTypeRequiredDescription
idstringYes
channelenumYesValues: "telegram", "viber"
user_idstringYes
urlstringYes
tokenstringYes
expires_atstringYes

Example response:

{
  "url": "https://pushizo.com/orders/1001",
  "channel": "telegram",
  "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "token": "d1f2e3…",
  "expires_at": "örnek"
}

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

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/messenger-links" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "channel": "telegram",
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "external_id": "user_42",
  "ttl_seconds": 60
}'

Channel configurations

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ChannelList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
data[].providerenum | nullYes
data[].statusenumYesValues: "unconfigured", "active", "invalid", "suspended"
data[].configobjectYes
data[].config.auth_typeenumNoValues: "token", "certificate"
data[].config.certificate_environmentenumNoValues: "sandbox", "production", "universal"
data[].config.certificate_subjectstringNo
data[].config.certificate_expires_atstringNo
data[].config.key_idstringNo
data[].config.team_idstringNo
data[].config.bundle_idstringNo
data[].config.environmentenumNoValues: "sandbox", "production"
data[].config.project_idstringNo
data[].config.client_emailstringNo
data[].config.hms_app_idstringNo
data[].config.high_prioritybooleanNo
data[].config.subjectstringNo
data[].config.vapid_public_keystringNo
data[].config.site_urlstringNo
data[].config.from_addressstringNo
data[].config.from_namestringNo
data[].config.reply_tostringNo
data[].config.dkim_selectorstringNo
data[].config.postal_addressstringNo
data[].config.hoststringNo
data[].config.portintegerNo
data[].config.securebooleanNo
data[].config.usernamestringNo
data[].config.regionstringNo
data[].config.access_key_idstringNo
data[].config.configuration_setstringNo
data[].config.account_sidstringNo
data[].config.from_numberstringNo
data[].config.messaging_service_sidstringNo
data[].config.verify_service_sidstringNo
data[].config.usercodestringNo
data[].config.msgheaderstringNo
data[].config.iys_filterenumNoValues: "0", "11", "12"
data[].config.waba_idstringNo
data[].config.phone_number_idstringNo
data[].config.graph_api_versionstringNo
data[].config.display_phone_numberstringNo
data[].config.verified_namestringNo
data[].config.rbm_agent_idstringNo
data[].config.content_sidstringNo
data[].config.sms_fallbackbooleanNo
data[].config.telegram_bot_usernamestringNo
data[].config.viber_uristringNo
data[].config.viber_sender_namestringNo
data[].config.viber_sender_avatarstringNo
data[].config.webhook_registered_atstringNo
data[].has_secretbooleanYes
data[].has_hookbooleanYes
data[].last_validated_atstring | nullYes
data[].last_errorstring | nullYes
data[].updated_atstring | nullYes
data[].suspended_reasonstring | nullYes
data[].dns_checkobject | nullYes

Example response:

{
  "data": [
    {
      "channel": "ios_push",
      "status": "unconfigured",
      "provider": "apns",
      "config": {
        "auth_type": "token",
        "certificate_environment": "sandbox"
      },
      "has_secret": true,
      "has_hook": true,
      "last_validated_at": "örnek",
      "last_error": "örnek",
      "updated_at": "örnek",
      "suspended_reason": "örnek",
      "dns_check": {
        "domain": "örnek",
        "checked_at": "örnek",
        "spf": {
          "ok": true,
          "record": "örnek",
          "expected": "örnek"
        },
        "dkim": {
          "ok": true,
          "selector": "örnek",
          "record": "örnek",
          "expected": "örnek"
        },
        "dmarc": {
          "ok": true,
          "record": "örnek",
          "expected": "örnek"
        },
        "issues": [
          "ö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/channels" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Channel summary (provider and status only; no configuration details are returned)

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ChannelStatusList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].channelstringYes
data[].providerstring | nullYes
data[].statusstringYes

Example response:

{
  "data": [
    {
      "channel": "web_push",
      "status": "örnek",
      "provider": "ö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/channels/status" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

SPF/DKIM/DMARC verification of the sender domain

POST/v1/apps/{appId}/channels/email/verify-dnsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.
FieldTypeRequiredDescription
domainstringYes
checked_atstringYes
spfobjectYes
spf.okbooleanYes
spf.recordstring | nullYes
spf.expectedstringYes
dkimobjectYes
dkim.okbooleanYes
dkim.selectorstringYes
dkim.recordstring | nullYes
dkim.expectedstringYes
dmarcobjectYes
dmarc.okbooleanYes
dmarc.recordstring | nullYes
dmarc.expectedstringYes
issuesarray<string>Yes

Example response:

{
  "domain": "örnek",
  "checked_at": "örnek",
  "spf": {
    "ok": true,
    "record": "örnek",
    "expected": "örnek"
  },
  "dkim": {
    "ok": true,
    "selector": "örnek",
    "record": "örnek",
    "expected": "örnek"
  },
  "dmarc": {
    "ok": true,
    "record": "örnek",
    "expected": "örnek"
  },
  "issues": [
    "örnek"
  ]
}

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

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/channels/email/verify-dns" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Upload credentials (APNs p8, FCM service account, VAPID, mock)

PUT/v1/apps/{appId}/channels/{channel}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
channelpathstringYes"web_push"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Type: object

Example:

{
  "provider": "apns",
  "key_id": "key_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "bundle_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_clip_bundle_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "environment": "sandbox"
}

Responses

200 — Success.

Schema: ChannelConfig

FieldTypeRequiredDescription
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
providerenum | nullYes
statusenumYesValues: "unconfigured", "active", "invalid", "suspended"
configobjectYes
config.auth_typeenumNoValues: "token", "certificate"
config.certificate_environmentenumNoValues: "sandbox", "production", "universal"
config.certificate_subjectstringNo
config.certificate_expires_atstringNo
config.key_idstringNo
config.team_idstringNo
config.bundle_idstringNo
config.environmentenumNoValues: "sandbox", "production"
config.project_idstringNo
config.client_emailstringNo
config.hms_app_idstringNo
config.high_prioritybooleanNo
config.subjectstringNo
config.vapid_public_keystringNo
config.site_urlstringNo
config.from_addressstringNo
config.from_namestringNo
config.reply_tostringNo
config.dkim_selectorstringNo
config.postal_addressstringNo
config.hoststringNo
config.portintegerNo
config.securebooleanNo
config.usernamestringNo
config.regionstringNo
config.access_key_idstringNo
config.configuration_setstringNo
config.account_sidstringNo
config.from_numberstringNo
config.messaging_service_sidstringNo
config.verify_service_sidstringNo
config.usercodestringNo
config.msgheaderstringNo
config.iys_filterenumNoValues: "0", "11", "12"
config.waba_idstringNo
config.phone_number_idstringNo
config.graph_api_versionstringNo
config.display_phone_numberstringNo
config.verified_namestringNo
config.rbm_agent_idstringNo
config.content_sidstringNo
config.sms_fallbackbooleanNo
config.telegram_bot_usernamestringNo
config.viber_uristringNo
config.viber_sender_namestringNo
config.viber_sender_avatarstringNo
config.webhook_registered_atstringNo
has_secretbooleanYes
has_hookbooleanYes
last_validated_atstring | nullYes
last_errorstring | nullYes
updated_atstring | nullYes
suspended_reasonstring | nullYes
dns_checkobject | nullYes

Example response:

{
  "channel": "ios_push",
  "status": "unconfigured",
  "provider": "apns",
  "config": {
    "auth_type": "token",
    "certificate_environment": "sandbox",
    "certificate_subject": "örnek",
    "certificate_expires_at": "örnek"
  },
  "has_secret": true,
  "has_hook": true,
  "last_validated_at": "örnek",
  "last_error": "örnek",
  "updated_at": "örnek",
  "suspended_reason": "örnek",
  "dns_check": {
    "domain": "örnek",
    "checked_at": "örnek",
    "spf": {
      "ok": true,
      "record": "örnek",
      "expected": "örnek"
    },
    "dkim": {
      "ok": true,
      "selector": "örnek",
      "record": "örnek",
      "expected": "örnek"
    },
    "dmarc": {
      "ok": true,
      "record": "örnek",
      "expected": "örnek"
    },
    "issues": [
      "ö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/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/channels/web_push" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "provider": "apns",
  "key_id": "key_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "bundle_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_clip_bundle_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "environment": "sandbox"
}'

Test connection to the provider

POST/v1/apps/{appId}/channels/{channel}/validateTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
channelpathstringYes"web_push"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ChannelValidation

FieldTypeRequiredDescription
okbooleanYes
kindenum | nullYes
codestring | nullYes
messagestring | nullYes
detailsmap<string, any> | nullYes
channelobjectYes
channel.channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
channel.providerenum | nullYes
channel.statusenumYesValues: "unconfigured", "active", "invalid", "suspended"
channel.configobjectYes
channel.config.auth_typeenumNoValues: "token", "certificate"
channel.config.certificate_environmentenumNoValues: "sandbox", "production", "universal"
channel.config.certificate_subjectstringNo
channel.config.certificate_expires_atstringNo
channel.config.key_idstringNo
channel.config.team_idstringNo
channel.config.bundle_idstringNo
channel.config.environmentenumNoValues: "sandbox", "production"
channel.config.project_idstringNo
channel.config.client_emailstringNo
channel.config.hms_app_idstringNo
channel.config.high_prioritybooleanNo
channel.config.subjectstringNo
channel.config.vapid_public_keystringNo
channel.config.site_urlstringNo
channel.config.from_addressstringNo
channel.config.from_namestringNo
channel.config.reply_tostringNo
channel.config.dkim_selectorstringNo
channel.config.postal_addressstringNo
channel.config.hoststringNo
channel.config.portintegerNo
channel.config.securebooleanNo
channel.config.usernamestringNo
channel.config.regionstringNo
channel.config.access_key_idstringNo
channel.config.configuration_setstringNo
channel.config.account_sidstringNo
channel.config.from_numberstringNo
channel.config.messaging_service_sidstringNo
channel.config.verify_service_sidstringNo
channel.config.usercodestringNo
channel.config.msgheaderstringNo
channel.config.iys_filterenumNoValues: "0", "11", "12"
channel.config.waba_idstringNo
channel.config.phone_number_idstringNo
channel.config.graph_api_versionstringNo
channel.config.display_phone_numberstringNo
channel.config.verified_namestringNo
channel.config.rbm_agent_idstringNo
channel.config.content_sidstringNo
channel.config.sms_fallbackbooleanNo
channel.config.telegram_bot_usernamestringNo
channel.config.viber_uristringNo
channel.config.viber_sender_namestringNo
channel.config.viber_sender_avatarstringNo
channel.config.webhook_registered_atstringNo
channel.has_secretbooleanYes
channel.has_hookbooleanYes
channel.last_validated_atstring | nullYes
channel.last_errorstring | nullYes
channel.updated_atstring | nullYes
channel.suspended_reasonstring | nullYes
channel.dns_checkobject | nullYes

Example response:

{
  "channel": {
    "channel": "ios_push",
    "status": "unconfigured",
    "provider": "apns",
    "config": {
      "auth_type": "token",
      "certificate_environment": "sandbox"
    },
    "has_secret": true,
    "has_hook": true,
    "last_validated_at": "örnek",
    "last_error": "örnek",
    "updated_at": "örnek",
    "suspended_reason": "örnek",
    "dns_check": {
      "domain": "örnek",
      "checked_at": "örnek",
      "spf": {
        "ok": true,
        "record": "örnek",
        "expected": "örnek"
      },
      "dkim": {
        "ok": true,
        "selector": "örnek",
        "record": "örnek",
        "expected": "örnek"
      },
      "dmarc": {
        "ok": true,
        "record": "örnek",
        "expected": "örnek"
      },
      "issues": [
        "örnek"
      ]
    }
  },
  "ok": true,
  "kind": "auth",
  "code": "örnek",
  "message": "Takip bağlantısı içeride",
  "details": {
    "key": "örnek"
  }
}

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

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/channels/web_push/validate" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

On this page