ffbe66a389
* fix relrefs around trends and related entities * revert moving caption-links to middle of page * hide empty menu in table of contents * clarify edit notifs are only for boosted statuses * following/followers no longer need auth * fix typo * specify cooldown period for account Move * use the correct cooldown * add missing parameters to accounts/id/statuses * link to account_statuses_filter.rb * fix typo (#1072) * fix typo (#1073) * fix link to http sig spec (#1067) * simply HTTP request examples in api methods docs * add missing client_secret to oauth/token (#1062) * Add any, all, none to hashtag timeline * minor formatting changes * Update signature requirements and advice * fix public key -> private key * clarify use of RSA with SHA256 * Add note about saving your profile after adding rel-me link * v2 filters api * comment out params that shouldn't be used in v2 filter api * admin trends * remove old todo * canonical email blocks + scheduled statuses * remove under-construction warnings from finished pages * verify api method params with source code * fix typo (#1088) * fix broken caption-links (#1100) * fix formatting of entities (#1094) * Remove keybase section from user guide (#1093) * fix typos (#1092) * Verify limits are accurate (#1086) * add mention of iframe limitation (#1084) * Add CORS header to WEB_DOMAIN example (#1083) * Fix typo (#1081) * pin http sigs spec at draft 8 * Revert "pin http sigs spec at draft 8" This reverts commit 9fd5f7032b69b29e77599dd62adfe8d2f5cd4f20. * add case sensitivity warning to 4.0 roles * Add url length note to bio (#1087) * remove follow scope from examples (#1103) * clarify usage of update_credentials to update profile fields * add noindex to Account entitity * remove required hint from technically not required property
3.4 KiB
| title | description | menu | aliases | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Notification | Represents a notification of an event relevant to the user. |
|
|
Attributes
id
Description: The id of the notification in the database.
Type: String (cast from an integer, but not guaranteed to be a number)
Version history:
0.9.9 - added
type
Description: The type of event that resulted in the notification.
Type: String (Enumerable oneOf)
mention = Someone mentioned you in their status
status = Someone you enabled notifications for has posted a status
reblog = Someone boosted one of your statuses
follow = Someone followed you
follow_request = Someone requested to follow you
favourite = Someone favourited one of your statuses
poll = A poll you have voted in or created has ended
update = A status you interacted with has been edited
admin.sign_up = Someone signed up (optionally sent to admins)
admin.report = A new report has been filed
Version history:
0.9.9 - added
2.8.0 - added poll
3.1.0 - added follow_request
3.3.0 - added status
3.5.0 - added update and admin.sign_up
4.0.0 - added admin.report
created_at
Description: The timestamp of the notification.
Type: String (ISO 8601 Datetime)
Version history:
0.9.9 - added
account
Description: The account that performed the action that generated the notification.
Type: [Account]({{< relref "entities/Account" >}})
Version history:
0.9.9 - added
status {{%optional%}}
Description: Status that was the object of the notification. Attached when type of the notification is favourite, reblog, status, mention, poll, or update.
Type: [Status]({{< relref "entities/Status" >}})
Version history:
0.9.9 - added
report {{%optional%}}
Description: Report that was the object of the notification. Attached when type of the notification is admin.report.
Type: [Report]({{< relref "entities/Report" >}})
Version history:
4.0.0 - added
Examples
Mention
{
"id": "34975861",
"type": "mention",
"created_at": "2019-11-23T07:49:02.064Z",
"account": {
"id": "971724",
"username": "zsc",
"acct": "zsc",
// ...
},
"status": {
"id": "103186126728896492",
"created_at": "2019-11-23T07:49:01.940Z",
"in_reply_to_id": "103186038209478945",
"in_reply_to_account_id": "14715",
// ...
}
}
Favourite
{
"id": "34975535",
"type": "favourite",
"created_at": "2019-11-23T07:29:18.903Z",
"account": {
"id": "297420",
"username": "haskal",
"acct": "haskal@cybre.space",
// ...
},
"status": {
"id": "103186046267791694",
"created_at": "2019-11-23T07:28:34.210Z",
// ...
"account": {
"id": "14715",
"username": "trwnh",
"acct": "trwnh",
// ...
},
// ...
}
}
See also
{{< page-relref ref="methods/notifications" caption="notifications API methods" >}}
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/notification_serializer.rb" caption="app/serializers/rest/notification_serializer.rb" >}}