Skip to main content
POST
/
web-push
/
subscribe
Subscribe to web push with authentication
curl --request POST \
  --url https://push.platform.arb.inc/web-push/subscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscription": {
    "endpoint": "https://fcm.googleapis.com/fcm/send/abc123def456",
    "keys": {
      "p256dh": "BKxMsq8lMmxKd_GFzCPJzCl8hQ3vVdYlQCL_bN8cLQhFk8z5pQ9hN1lMrT4xW2kP3sQ7",
      "auth": "8sFHd5kNuLVhw2pQ9xN1mT4"
    }
  },
  "vapidKey": "BNcRdreALRFXTkOOUHK1EtK2wtaz5Ry4YfYCA_0QTpQtUbVlUK3qW_HkkDQ3CskBSRU481zCtgwtR_jYDg9gNqk"
}
'
{
  "subscriptionID": "3f8c7e4d-2a1b-4c9d-8e7f-6a5b4c3d2e1f"
}

Authorizations

​
Authorization
string
header
required

access token

Body

application/json
​
subscription
object
required

Browser PushSubscription object containing endpoint and encryption keys

​
vapidKey
string
required

VAPID public key that was used during browser subscription

Example:

"BNcRdreALRFXTkOOUHK1EtK2wtaz5Ry4YfYCA_0QTpQtUbVlUK3qW_HkkDQ3CskBSRU481zCtgwtR_jYDg9gNqk"

Response

200 - application/json

Successfully subscribed to web push notifications

​
subscriptionID
string

Unique identifier for this subscription

Example:

"3f8c7e4d-2a1b-4c9d-8e7f-6a5b4c3d2e1f"