PushSubscription

Represents a subscription to the push streaming server.

Example

{
  "id": 328183,
  "endpoint": "https://yourdomain.example/listener",
  "alerts": {
    "follow": false,
    "favourite": false,
    "reblog": false,
    "mention": true,
    "poll": false
  },
  "server_key": "BCk-QqERU0q-CfYZjcuB6lnyyOYfJ2AifKqfeGIm7Z-HiTU5T9eTG5GxVA0_OH5mMlI4UkkDTpaZwozy0TzdZ2M="
}

Required attributes

`id`

Description: The id of the push subscription in the database. Type: String (cast from an integer, but not guaranteed to be a number) Version history: Added in 2.4.0

`endpoint`

Description: Where push alerts will be sent to. Type: String (URL) Version history: Added in 2.4.0

`server_key`

Description: The streaming server's VAPID key. Type: String Version history: Added in 2.4.0

`alerts`

Description: Which alerts should be delivered to the endpoint. Type: Hash Version history: Added in 2.4.0. alerts[poll] added in 2.8.0.

`alerts[follow]`

Receive a push notification when someone has followed you? Boolean.

`alerts[favourite]`

Receive a push notification when a status you created has been favourited by someone else? Boolean.

`alerts[mention]`

Receive a push notification when someone else has mentioned you in a status? Boolean.

`alerts[reblog]`

Receive a push notification when a status you created has been boosted by someone else? Boolean.

`alerts[poll]`

Receive a push notification when a poll you voted in or created has ended? Boolean. Added in 2.8.0

Example

Required attributes

id

endpoint

server_key

alerts

alerts[follow]

alerts[favourite]

alerts[mention]

alerts[reblog]

alerts[poll]

See also