Skip to main content
POST
Register a device for push

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Body

application/json
notification_subscription
object
required

The device to register.

Response

Success

id
integer

The numeric ID of the subscription.

user_id
integer

The user the device belongs to.

subscription_type
enum<string>

Web push, or Firebase Cloud Messaging for the mobile apps.

Available options:
browser_push,
fcm
subscription_attributes
object

The provider's own payload — endpoint and keys for web push, the device token for FCM.

identifier
string

Derived from the subscription attributes and used to de-duplicate devices.

created_at
string

ISO-8601 timestamp of registration.

updated_at
string

ISO-8601 timestamp of the last change.