InvergeDocs

Push notifications

Device tokens, sends and open tracking.

SDK-facing (API-key) push device-token registration. The SDK registers the device's FCM/APNs/WebPush token (with its journey identity) so campaigns and transactional sends can reach it; it unregisters on logout/uninstall. Un-prefixed (/partner/...).

MethodPathSummary
POST/partner/push/opened
POST/partner/push/register
POST/partner/push/sendServer-side transactional push — target users, segments, a filter, or all.
POST/partner/push/unregister

POST /partner/push/opened

POST 200 x-api-key

Body — OpenedDto

Prop

Type

Request
curl -X POST 'https://services.inverge.net/partner/push/opened' \
  -H 'x-api-key: nxs_live_xxx' \
  -H 'content-type: application/json' \
  -d '{
      "campaignId": "string",
      "token": "fcm-or-apns-token"
    }'

POST /partner/push/register

POST 200 x-api-key

Body — RegisterTokenDto

Prop

Type

Request
curl -X POST 'https://services.inverge.net/partner/push/register' \
  -H 'x-api-key: nxs_live_xxx' \
  -H 'content-type: application/json' \
  -d '{
      "token": "fcm-or-apns-token",
      "platform": "ios",
      "provider": "fcm"
    }'

POST /partner/push/send

POST 200 x-api-key

Server-side transactional push — target users, segments, a filter, or all.

Body — PartnerPushSendDto

Prop

Type

Request
curl -X POST 'https://services.inverge.net/partner/push/send' \
  -H 'x-api-key: nxs_live_xxx' \
  -H 'content-type: application/json' \
  -d '{
      "title": "Your order shipped"
    }'

POST /partner/push/unregister

POST 200 x-api-key

Body — UnregisterTokenDto

Prop

Type

Request
curl -X POST 'https://services.inverge.net/partner/push/unregister' \
  -H 'x-api-key: nxs_live_xxx' \
  -H 'content-type: application/json' \
  -d '{
      "token": "fcm-or-apns-token"
    }'

On this page