Skip to main content

​
Endpoint reference

MethodRouteAuthPurpose
POST/devicesUserRegister device for push notifications
DELETE/devices/:deviceTokenUserUnregister a device
POST/devices/push-to-start-tokenUserRegister push-to-start token
POST/admin/notifications/pushAdminSend a manual push notification
GET/admin/notifications/usersAdminList users with push tokens
GET/admin/notifications/subscriptionsAdminList notification subscriptions

​
Device registration

See the Device registration business flow for the full end-to-end journey.

​
POST /devices User

Register a device for push notifications (APNs).
​
deviceToken
string
required
The APNs device token from the iOS app.
​
platform
string
required
Device platform. Currently only ios is supported.
{
  "deviceToken": "abc123def456...",
  "platform": "ios"
}

​
DELETE /devices/:deviceToken User

Unregister a device. Call this on logout or when the user disables notifications.
​
deviceToken
string
required
The APNs device token to remove.

​
POST /devices/push-to-start-token User

Register a push-to-start token for iOS Live Activities. This token allows the backend to start a Live Activity on the device without the app being in the foreground.
​
pushToStartToken
string
required
The push-to-start token from the iOS app.
​
matchId
string
required
The match this token is associated with.

​
Admin notifications

​
POST /admin/notifications/push Admin

Send a manual push notification to one or more users.
​
title
string
required
Notification title.
​
body
string
required
Notification body text.
​
userIds
string[]
Target specific users. Omit to broadcast to all users with push tokens.
​
matchId
string
Associate the notification with a match (for deep linking).
Broadcasting to all users sends to every registered device. Use with care.

​
GET /admin/notifications/users Admin

List users who have registered push notification tokens.

​
GET /admin/notifications/subscriptions Admin

List all active notification subscriptions (match follows with push enabled).