mirror of
https://github.com/mastodon/documentation
synced 2025-04-11 22:56:17 +02:00
3628b6d434
* add rules * join date on profiles * deprecate follow scope * deprecate identity proofs * familiar followers * use definition lists instead of tables for defining activitypub properties * reformat notifications page into markdown * fix broken links to publicKey header * Application website is now nullable * update environment variables added and removed * fix typo * fix heading level * min_id and max_id can be used at the same time (3.3) * fix typo * new tootctl options * reformat tootctl page to use definition lists for params * add rules and configuration to Instance * fix typo * refactor instance api page * 3.3.0 duration on mutes * 3.3.0 mute_expires_at * improve section headings * 3.4.0 resend email confirmation api * 3.4.0 policy on push subscriptions * 3.4.0 add details to account registration error * refactor accounts api page and start adding relrefs to entity pages * 3.4.0 accounts/lookup api * add see also to accounts methods * add more see-also links * 3.5.0 appeal mod decisions * 3.5.0 reformat reports and add category/rule_ids params * document report entity and missing responses * fix typos * fix relrefs and url schema, add aliases to old urls * add archetypes for new methods/entities * update archetypes with see-also stubs * clearer presentation of rate limits * announcements api methods * refactor apps methods * refactor bookmarks methods + some anchors * refactor conversations methods * custom_emojis methods refactor * anchors * refactor directory methods * refactor domain_blocks methods * add see also to emails methods * fix page relref shortcodes to specific methods + refactor endorsements methods * min_id max_id * refactor favourites methods * refactor featured_tags methods * refactor filters methods, make path params consistent, i18n required shortcode * follow_requests methods * lists methods * markers methods * forgot to add entity links * media methods, also fix formatting of some json errors * mutes methods, add more see-also links * oembed methods * preferences methods * proofs methods * push methods * suggestions methods * 3.5.0 add new trend types, fix formatting * refactor streaming methods * refactor oauth methods * note that streaming api casts payload to string * refactor search methods * refactor polls methods * remove unnecessary link * reformat scheduled_statuses methods * reformat timelines methods * reformat statuses methods * 3.5.0 editing statuses * consistent use of array brackets in form data parameters * update dev setup guide, add vagrant and clean up text * add admin/accounts methods * 3.6 role entity * admin/accounts methods v2 * minor fix * stub admin/reports methods * document admin reports * add 403 example to methods archetype * cleanup entities for admin reports and add new attrs * 3.6.0 domain allows methods + normalize admin entity namespace * fix search-and-replace error * add aliases for admin entities * 3.6.0 canonical email blocks entity * 3.5.0 admin/retention api * 3.5.0 add admin::ip doc * 3.5.0 admin/reports * 3.6.0 admin/domain_allows * 3.5.0 admin/dimensions * 3.6.0 permissions and roles * minor formatting fix * add anchor link to headings * checkpoint * add update commands to dev env setup guide * change mentions of v3.6 to v4.0 * tootctl now uses custom roles * fix formatting * v2 instance api * update frontmatter, add better titles to pages * minor wording change * consistency * add more aliases * add placeholders and WIP notices * explain link pagination and stub out todos * switch baseURL to https * 422 on reports with rules but category!=violation * document bug fixes * fix typo * remove duplicate API method definition * s/tootsuite/mastodon for github links * remove unnecessary escaping * s/tootsuite/mastodon in Entity archetype * add missing nullable shortcode * clarify oauth scope when requesting a user token * api/v2/media now synchronous for images * DISALLOW_UNAUTHENTICATED_API_ACCESS * add undocumented env variables * add instance domain blocks and extended description api * add SMTP_ENABLE_STARTTLS * add description to SMTP_ENABLE_STARTTLS * take suggestions from open PRs * normalize links and flavour language * Fully document streaming API based on source code * Add mention of MIME types * bump to ruby 3.0.4 * clarify how to check on async media processing * validation of replies_policy * remove TODOs on admin account action * EmailDomainBlocks * IpBlocks * Admin::DomainBlock * remove TODOs * following hashtags * followed_tags * remove reference to unused parameter * add new oauth scopes for admin blocks and allows * fix command signature for i18n-tasks normalize * reformat code structure page * document fixes for following tags (assume 4.0.3) * Add warning about pre-4.0 hardcoded roles * add note about case sensitivity * remove use of 'simply' from docs * remove reference to silencing * add reference to IDN normalization for verified links * add lang parameter
149 lines
3.7 KiB
Markdown
149 lines
3.7 KiB
Markdown
---
|
|
title: WebPushSubscription
|
|
description: Represents a subscription to the push streaming server.
|
|
menu:
|
|
docs:
|
|
parent: entities
|
|
aliases: [
|
|
"/entities/pushsubscription",
|
|
"/entities/PushSubscription",
|
|
"/entities/webpushsubscription",
|
|
"/entities/WebPushSubscription",
|
|
"/api/entities/pushsubscription",
|
|
"/api/entities/PushSubscription",
|
|
"/api/entities/webpushsubscription",
|
|
"/api/entities/WebPushSubscription",
|
|
]
|
|
---
|
|
|
|
## Example
|
|
|
|
```json
|
|
{
|
|
"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="
|
|
}
|
|
```
|
|
|
|
## Attributes
|
|
|
|
### `id` {#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` {#endpoint}
|
|
|
|
**Description:** Where push alerts will be sent to.\
|
|
**Type:** String (URL)\
|
|
**Version history:**\
|
|
2.4.0 - added
|
|
|
|
### `server_key` {#server_key}
|
|
|
|
**Description:** The streaming server's VAPID key.\
|
|
**Type:** String\
|
|
**Version history:**\
|
|
2.4.0 - added
|
|
|
|
### `alerts` {#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]` {#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]` {#status}
|
|
|
|
**Description:** Receive a push notification when a subscribed account posts a status?\
|
|
**Type:** Boolean\
|
|
**Version history:**\
|
|
3.3.0 - added
|
|
|
|
#### `alerts[reblog]` {#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]` {#follow}
|
|
|
|
**Description:** Receive a push notification when someone has followed you?\
|
|
**Type:** Boolean\
|
|
**Version history:**\
|
|
2.4.0 - added
|
|
|
|
#### `alerts[follow_request]` {#follow_request}
|
|
|
|
**Description:** Receive a push notification when someone has requested to followed you?\
|
|
**Type:** Boolean\
|
|
**Version history:**\
|
|
3.1.0 - added
|
|
|
|
#### `alerts[favourite]` {#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]` {#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]` {#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]` {#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]` {#admin-report}
|
|
|
|
**Description:** Receive a push notification when a new report has been filed?\
|
|
**Type:** Boolean\
|
|
**Version history:**\
|
|
4.0.0 - added
|
|
|
|
## See also
|
|
|
|
{{< page-relref ref="methods/push" caption="push API methods" >}}
|
|
|
|
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/web_push_subscription_serializer.rb" caption="app/serializers/rest/web_push_subscription_serializer.rb" >}}
|
|
|
|
|
|
|