Subscribe to push notifications

POST

/api/push/subscribe

curl --request POST \
  --url http://localhost:3001/api/push/subscribe \
  --header 'Content-Type: application/json' \
  --data '{ "endpoint": "example", "keys": { "auth": "example", "p256dh": "example" } }'

• Local development
• Production

Register a push notification subscription for the authenticated user

Request Body^required

Push subscription details

Media typeapplication/json

object

endpoint

string

keys

object

auth

string

p256dh

string

Example^generated

{
  "endpoint": "example",
  "keys": {
    "auth": "example",
    "p256dh": "example"
  }
}

Responses

200

OK

Media typeapplication/json

object

key

additional properties

any

Example^generated

{}

400

Bad Request

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

401

Unauthorized

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

500

Internal Server Error

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}