WebPushSubscription

Represents a subscription to the push streaming server.

Example 

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

Attributes

id

Description: The ID of the Web Push subscription in the database.
Type: String (cast from an integer, but not guaranteed to be a number)
Version history:
2.4.0 - added

endpoint

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

standard

Description: If the push messages follow the standardized specifications (RFC8030+RFC8291+RFC8292). Else they follow a legacy version of the specifications (4th draft of RFC8291 and 1st draft of RFC8292). Type: Boolean Version history:
4.4.0 - added

server_key

Description: The streaming server’s VAPID key.
Type: String
Version history:
2.4.0 - added

alerts

Description: Which alerts should be delivered to the endpoint.
Type: Hash
Version history:
2.4.0 - added
2.8.0 - added alerts[poll]
3.1.0 - added alerts[follow_request]
3.3.0 - added alerts[status]
3.5.0 - added alerts[update] and alerts[admin.sign_up]
4.0.0 - added alerts[admin.report]

alerts[mention]

Description: Receive a push notification when someone else has mentioned you in a status?
Type: Boolean
Version history:
2.4.0 - added

alerts[status]

Description: Receive a push notification when a subscribed account posts a status?
Type: Boolean
Version history:
3.3.0 - added

alerts[reblog]

Description: Receive a push notification when a status you created has been boosted by someone else?
Type: Boolean
Version history:
2.4.0 - added

alerts[follow]

Description: Receive a push notification when someone has followed you?
Type: Boolean
Version history:
2.4.0 - added

alerts[follow_request]

Description: Receive a push notification when someone has requested to followed you?
Type: Boolean
Version history:
3.1.0 - added

alerts[favourite]

Description: Receive a push notification when a status you created has been favourited by someone else?
Type: Boolean
Version history:
2.4.0 - added

alerts[poll]

Description: Receive a push notification when a poll you voted in or created has ended?
Type: Boolean
Version history:
2.8.0 - added

alerts[update]

Description: Receive a push notification when a status you interacted with has been edited?
Type: Boolean
Version history:
3.5.0 - added

alerts[admin.sign_up]

Description: Receive a push notification when a new user has signed up?
Type: Boolean
Version history:
3.5.0 - added

alerts[admin.report]

Description: Receive a push notification when a new report has been filed?
Type: Boolean
Version history:
4.0.0 - added

See also

push API methods
app/serializers/rest/web_push_subscription_serializer.rb

Last updated · Improve this page