Skip to main content

Push Devices

Push Device Registration​

Register a device to receive push notifications via FCM.

Register a Device​

POST /api/v1/notifications/register-push-device
{
  "fcmToken": "firebase-cloud-messaging-token",
  "platform": "PLATFORM_IOS",
  "deviceId": "device-unique-id"
}

Response:

{
  "subscriberId": "user_123",
  "success": true
}

Unregister a Device​

POST /api/v1/notifications/unregister-push-device
{
  "fcmToken": "firebase-cloud-messaging-token"
}

Response:

{
  "subscriberId": "user_123"
}

remainingCredentialCount appears when > 0 (other devices still registered).

Get Registered Channels​

Check which notification channels are available for the current user.

POST /api/v1/notifications/get-registered-channels
{}

Response:

{
  "channels": [
    {"channel": "CHANNEL_IN_APP", "registered": true, "credentialCount": 1},
    {"channel": "CHANNEL_PUSH"},
    {"channel": "CHANNEL_EMAIL", "registered": true, "credentialCount": 1},
    {"channel": "CHANNEL_SMS"}
  ]
}

Channels without credentials omit registered and credentialCount.