Notifications/API

From mediawiki.org

meta=notifications (not)

(main | query | notifications)
  • This module requires read rights.
  • Source: Echo
  • License: MIT

Get notifications waiting for the current user.

Parameters:
notwikis

List of wikis to fetch notifications from (defaults to only current wiki).

Values (separate with | or alternative): *, aawiki, aawikibooks, aawiktionary, abwiki, abwiktionary, acewiki, advisorswiki, advisorywiki, adywiki, afwiki, afwikibooks, afwikiquote, afwiktionary, akwiki, akwikibooks, akwiktionary, alswiki, altwiki, amiwiki, amwiki, amwikimedia, amwikiquote, amwiktionary, angwiki, angwikibooks, angwikiquote, angwikisource, angwiktionary, anwiki, anwiktionary, apiportalwiki, arbcom_cswiki, arbcom_dewiki, arbcom_enwiki, arbcom_fiwiki, arbcom_nlwiki, arbcom_ruwiki, arcwiki, arwiki, arwikibooks, arwikimedia, arwikinews, arwikiquote, arwikisource, arwikiversity, arwiktionary, arywiki, arzwiki, astwiki, astwikibooks, astwikiquote, astwiktionary, aswiki, aswikibooks, aswikisource, aswiktionary, atjwiki, auditcomwiki, avkwiki, avwiki, avwiktionary, awawiki, aywiki, aywikibooks, aywiktionary, azbwiki, azwiki, azwikibooks, azwikiquote, azwikisource, azwiktionary, banwiki, banwikisource, barwiki, bat_smgwiki, bawiki, bawikibooks, bclwiki, bclwiktionary, bdwikimedia, be_x_oldwiki, betawikiversity, bewiki, bewikibooks, bewikimedia, bewikiquote, bewikisource, bewiktionary, bgwiki, bgwikibooks, bgwikinews, bgwikiquote, bgwikisource, bgwiktionary, bhwiki, bhwiktionary, biwiki, biwikibooks, biwiktionary, bjnwiki, bmwiki, bmwikibooks, bmwikiquote, bmwiktionary, bnwiki, bnwikibooks, bnwikisource, bnwikivoyage, bnwiktionary, boardgovcomwiki, boardwiki, bowiki, bowikibooks, bowiktionary, bpywiki, brwiki, brwikimedia, brwikiquote, brwikisource, brwiktionary, bswiki, bswikibooks, bswikinews, bswikiquote, bswikisource, bswiktionary, bugwiki, bxrwiki, cawiki, cawikibooks, cawikimedia, cawikinews, cawikiquote, cawikisource, cawiktionary, cbk_zamwiki, cdowiki, cebwiki, cewiki, chairwiki, chapcomwiki, checkuserwiki, chowiki, chrwiki, chrwiktionary, chwiki, chwikibooks, chwiktionary, chywiki, ckbwiki, cnwikimedia, collabwiki, commonswiki, cowiki, cowikibooks, cowikimedia, cowikiquote, cowiktionary, crhwiki, crwiki, crwikiquote, crwiktionary, csbwiki, csbwiktionary, cswiki, cswikibooks, cswikinews, cswikiquote, cswikisource, cswikiversity, cswiktionary, cuwiki, cvwiki, cvwikibooks, cywiki, cywikibooks, cywikiquote, cywikisource, cywiktionary, dagwiki, dawiki, dawikibooks, dawikiquote, dawikisource, dawiktionary, dewiki, dewikibooks, dewikinews, dewikiquote, dewikisource, dewikiversity, dewikivoyage, dewiktionary, dinwiki, diqwiki, diqwiktionary, dkwikimedia, donatewiki, dsbwiki, dtywiki, dvwiki, dvwiktionary, dzwiki, dzwiktionary, ecwikimedia, eewiki, electcomwiki, elwiki, elwikibooks, elwikinews, elwikiquote, elwikisource, elwikiversity, elwikivoyage, elwiktionary, emlwiki, enwiki, enwikibooks, enwikinews, enwikiquote, enwikisource, enwikiversity, enwikivoyage, enwiktionary, eowiki, eowikibooks, eowikinews, eowikiquote, eowikisource, eowikivoyage, eowiktionary, eswiki, eswikibooks, eswikinews, eswikiquote, eswikisource, eswikiversity, eswikivoyage, eswiktionary, etwiki, etwikibooks, etwikimedia, etwikiquote, etwikisource, etwiktionary, euwiki, euwikibooks, euwikiquote, euwikisource, euwiktionary, execwiki, extwiki, fawiki, fawikibooks, fawikinews, fawikiquote, fawikisource, fawikivoyage, fawiktionary, fdcwiki, ffwiki, fiu_vrowiki, fiwiki, fiwikibooks, fiwikimedia, fiwikinews, fiwikiquote, fiwikisource, fiwikiversity, fiwikivoyage, fiwiktionary, fjwiki, fjwiktionary, foundationwiki, fowiki, fowikisource, fowiktionary, frpwiki, frrwiki, frwiki, frwikibooks, frwikinews, frwikiquote, frwikisource, frwikiversity, frwikivoyage, frwiktionary, furwiki, fywiki, fywikibooks, fywiktionary, gagwiki, ganwiki, gawiki, gawikibooks, gawikiquote, gawiktionary, gcrwiki, gdwiki, gdwiktionary, gewikimedia, glkwiki, glwiki, glwikibooks, glwikiquote, glwikisource, glwiktionary, gnwiki, gnwikibooks, gnwiktionary, gomwiki, gomwiktionary, gorwiki, gotwiki, gotwikibooks, grantswiki, grwikimedia, guwiki, guwikibooks, guwikiquote, guwikisource, guwiktionary, guwwiki, gvwiki, gvwiktionary, hakwiki, hawiki, hawiktionary, hawwiki, hewiki, hewikibooks, hewikinews, hewikiquote, hewikisource, hewikivoyage, hewiktionary, hifwiki, hifwiktionary, hiwiki, hiwikibooks, hiwikimedia, hiwikiquote, hiwikisource, hiwikiversity, hiwikivoyage, hiwiktionary, howiki, hrwiki, hrwikibooks, hrwikiquote, hrwikisource, hrwiktionary, hsbwiki, hsbwiktionary, htwiki, htwikisource, huwiki, huwikibooks, huwikinews, huwikiquote, huwikisource, huwiktionary, hywiki, hywikibooks, hywikiquote, hywikisource, hywiktionary, hywwiki, hzwiki, iawiki, iawikibooks, iawiktionary, id_internalwikimedia, idwiki, idwikibooks, idwikimedia, idwikiquote, idwikisource, idwiktionary, iegcomwiki, iewiki, iewikibooks, iewiktionary, igwiki, iiwiki, ikwiki, ikwiktionary, ilowiki, ilwikimedia, incubatorwiki, inhwiki, internalwiki, iowiki, iowiktionary, iswiki, iswikibooks, iswikiquote, iswikisource, iswiktionary, itwiki, itwikibooks, itwikinews, itwikiquote, itwikisource, itwikiversity, itwikivoyage, itwiktionary, iuwiki, iuwiktionary, jamwiki, jawiki, jawikibooks, jawikinews, jawikiquote, jawikisource, jawikiversity, jawikivoyage, jawiktionary, jbowiki, jbowiktionary, jvwiki, jvwikisource, jvwiktionary, kaawiki, kabwiki, kawiki, kawikibooks, kawikiquote, kawiktionary, kbdwiki, kbpwiki, kcgwiki, kgwiki, kiwiki, kjwiki, kkwiki, kkwikibooks, kkwikiquote, kkwiktionary, klwiki, klwiktionary, kmwiki, kmwikibooks, kmwiktionary, knwiki, knwikibooks, knwikiquote, knwikisource, knwiktionary, koiwiki, kowiki, kowikibooks, kowikinews, kowikiquote, kowikisource, kowikiversity, kowiktionary, krcwiki, krwiki, krwikiquote, kshwiki, kswiki, kswikibooks, kswikiquote, kswiktionary, kuwiki, kuwikibooks, kuwikiquote, kuwiktionary, kvwiki, kwwiki, kwwikiquote, kwwiktionary, kywiki, kywikibooks, kywikiquote, kywiktionary, labswiki, labtestwiki, ladwiki, lawiki, lawikibooks, lawikiquote, lawikisource, lawiktionary, lbewiki, lbwiki, lbwikibooks, lbwikiquote, lbwiktionary, legalteamwiki, lezwiki, lfnwiki, lgwiki, lijwiki, lijwikisource, liwiki, liwikibooks, liwikinews, liwikiquote, liwikisource, liwiktionary, lldwiki, lmowiki, lmowiktionary, lnwiki, lnwikibooks, lnwiktionary, loginwiki, lowiki, lowiktionary, lrcwiki, ltgwiki, ltwiki, ltwikibooks, ltwikiquote, ltwikisource, ltwiktionary, lvwiki, lvwikibooks, lvwiktionary, madwiki, maiwiki, maiwikimedia, map_bmswiki, mdfwiki, mediawikiwiki, metawiki, mgwiki, mgwikibooks, mgwiktionary, mhrwiki, mhwiki, mhwiktionary, minwiki, minwiktionary, miwiki, miwikibooks, miwiktionary, mkwiki, mkwikibooks, mkwikimedia, mkwikisource, mkwiktionary, mlwiki, mlwikibooks, mlwikiquote, mlwikisource, mlwiktionary, mniwiki, mniwiktionary, mnwiki, mnwikibooks, mnwiktionary, mnwwiki, mnwwiktionary, movementroleswiki, mrjwiki, mrwiki, mrwikibooks, mrwikiquote, mrwikisource, mrwiktionary, mswiki, mswikibooks, mswiktionary, mtwiki, mtwiktionary, muswiki, mwlwiki, mxwikimedia, myvwiki, mywiki, mywikibooks, mywiktionary, mznwiki, nahwiki, nahwikibooks, nahwiktionary, napwiki, napwikisource, nawiki, nawikibooks, nawikiquote, nawiktionary, nds_nlwiki, ndswiki, ndswikibooks, ndswikiquote, ndswiktionary, newiki, newikibooks, newiktionary, newwiki, ngwiki, ngwikimedia, niawiki, niawiktionary, nlwiki, nlwikibooks, nlwikimedia, nlwikinews, nlwikiquote, nlwikisource, nlwikivoyage, nlwiktionary, nnwiki, nnwikiquote, nnwiktionary, noboard_chapterswikimedia, nostalgiawiki, novwiki, nowiki, nowikibooks, nowikimedia, nowikinews, nowikiquote, nowikisource, nowiktionary, nqowiki, nrmwiki, nsowiki, nvwiki, nycwikimedia, nywiki, nzwikimedia, ocwiki, ocwikibooks, ocwiktionary, officewiki, olowiki, ombudsmenwiki, omwiki, omwiktionary, orwiki, orwikisource, orwiktionary, oswiki, otrs_wikiwiki, outreachwiki, pa_uswikimedia, pagwiki, pamwiki, papwiki, pawiki, pawikibooks, pawikisource, pawiktionary, pcdwiki, pdcwiki, pflwiki, pihwiki, piwiki, piwiktionary, plwiki, plwikibooks, plwikimedia, plwikinews, plwikiquote, plwikisource, plwikivoyage, plwiktionary, pmswiki, pmswikisource, pnbwiki, pnbwiktionary, pntwiki, projectcomwiki, pswiki, pswikibooks, pswikivoyage, pswiktionary, ptwiki, ptwikibooks, ptwikimedia, ptwikinews, ptwikiquote, ptwikisource, ptwikiversity, ptwikivoyage, ptwiktionary, punjabiwikimedia, pwnwiki, qualitywiki, quwiki, quwikibooks, quwikiquote, quwiktionary, rmwiki, rmwikibooks, rmwiktionary, rmywiki, rnwiki, rnwiktionary, roa_rupwiki, roa_rupwiktionary, roa_tarawiki, romdwikimedia, rowiki, rowikibooks, rowikinews, rowikiquote, rowikisource, rowikivoyage, rowiktionary, rswikimedia, ruewiki, ruwiki, ruwikibooks, ruwikimedia, ruwikinews, ruwikiquote, ruwikisource, ruwikiversity, ruwikivoyage, ruwiktionary, rwwiki, rwwiktionary, sahwiki, sahwikiquote, sahwikisource, satwiki, sawiki, sawikibooks, sawikiquote, sawikisource, sawiktionary, scnwiki, scnwiktionary, scowiki, scwiki, scwiktionary, sdwiki, sdwikinews, sdwiktionary, searchcomwiki, sewiki, sewikibooks, sewikimedia, sgwiki, sgwiktionary, shiwiki, shnwiki, shnwikivoyage, shnwiktionary, shwiki, shwiktionary, shywiktionary, simplewiki, simplewikibooks, simplewikiquote, simplewiktionary, siwiki, siwikibooks, siwiktionary, skrwiki, skrwiktionary, skwiki, skwikibooks, skwikiquote, skwikisource, skwiktionary, slwiki, slwikibooks, slwikiquote, slwikisource, slwikiversity, slwiktionary, smnwiki, smwiki, smwiktionary, snwiki, snwiktionary, sourceswiki, sowiki, sowiktionary, spcomwiki, specieswiki, sqwiki, sqwikibooks, sqwikinews, sqwikiquote, sqwiktionary, srnwiki, srwiki, srwikibooks, srwikinews, srwikiquote, srwikisource, srwiktionary, sswiki, sswiktionary, stewardwiki, stqwiki, strategywiki, stwiki, stwiktionary, suwiki, suwikibooks, suwikiquote, suwiktionary, svwiki, svwikibooks, svwikinews, svwikiquote, svwikisource, svwikiversity, svwikivoyage, svwiktionary, swwiki, swwikibooks, swwiktionary, sysop_itwiki, szlwiki, szywiki, tawiki, tawikibooks, tawikinews, tawikiquote, tawikisource, tawiktionary, taywiki, tcywiki, techconductwiki, tenwiki, test2wiki, testcommonswiki, testwiki, testwikidatawiki, tetwiki, tewiki, tewikibooks, tewikiquote, tewikisource, tewiktionary, tgwiki, tgwikibooks, tgwiktionary, thankyouwiki, thwiki, thwikibooks, thwikinews, thwikiquote, thwikisource, thwiktionary, tiwiki, tiwiktionary, tkwiki, tkwikibooks, tkwikiquote, tkwiktionary, tlwiki, tlwikibooks, tlwiktionary, tnwiki, tnwiktionary, towiki, towiktionary, tpiwiki, tpiwiktionary, transitionteamwiki, trvwiki, trwiki, trwikibooks, trwikimedia, trwikinews, trwikiquote, trwikisource, trwikivoyage, trwiktionary, tswiki, tswiktionary, ttwiki, ttwikibooks, ttwikiquote, ttwiktionary, tumwiki, twwiki, twwiktionary, tyvwiki, tywiki, uawikimedia, udmwiki, ugwiki, ugwikibooks, ugwikiquote, ugwiktionary, ukwiki, ukwikibooks, ukwikinews, ukwikiquote, ukwikisource, ukwikivoyage, ukwiktionary, urwiki, urwikibooks, urwikiquote, urwiktionary, usabilitywiki, uzwiki, uzwikibooks, uzwikiquote, uzwiktionary, vecwiki, vecwikisource, vecwiktionary, vepwiki, vewiki, viwiki, viwikibooks, viwikiquote, viwikisource, viwikivoyage, viwiktionary, vlswiki, votewiki, vowiki, vowikibooks, vowikiquote, vowiktionary, warwiki, wawiki, wawikibooks, wawikisource, wawiktionary, wbwikimedia, wg_enwiki, wikidatawiki, wikimania2005wiki, wikimania2006wiki, wikimania2007wiki, wikimania2008wiki, wikimania2009wiki, wikimania2010wiki, wikimania2011wiki, wikimania2012wiki, wikimania2013wiki, wikimania2014wiki, wikimania2015wiki, wikimania2016wiki, wikimania2017wiki, wikimania2018wiki, wikimaniateamwiki, wikimaniawiki, wowiki, wowikiquote, wowiktionary, wuuwiki, xalwiki, xhwiki, xhwikibooks, xhwiktionary, xmfwiki, yiwiki, yiwikisource, yiwiktionary, yowiki, yowikibooks, yowiktionary, yuewiktionary, zawiki, zawikibooks, zawikiquote, zawiktionary, zeawiki, zh_classicalwiki, zh_min_nanwiki, zh_min_nanwikibooks, zh_min_nanwikiquote, zh_min_nanwikisource, zh_min_nanwiktionary, zh_yuewiki, zhwiki, zhwikibooks, zhwikinews, zhwikiquote, zhwikisource, zhwikiversity, zhwikivoyage, zhwiktionary, zuwiki, zuwikibooks, zuwiktionary
Maximum number of values is 50 (500 for clients allowed higher limits).
Default: mediawikiwiki
notfilter

Filter notifications returned.

Values (separate with | or alternative): !read, read
Default: read|!read
notprop

Details to request.

Values (separate with | or alternative): count, list, seenTime
Default: list
notsections

The notification sections to query (i.e. some combination of 'alert' and 'message').

Values (separate with | or alternative): alert, message
Default: alert|message
notgroupbysection

Whether to group the result by section. Each section is fetched separately if set.

Type: boolean (details)
notformat

If specified, notifications will be returned formatted this way.

model
Raw notification data
special
Formatted for Special:Notifications page (and only that!) Do not rely on the HTML as it may change at any given time.
flyout
Deprecated. Use notformat=model for raw data
html
Deprecated. Use notformat=model for raw data
One of the following values: flyout, html, model, special
notlimit

The maximum number of notifications to return.

Type: integer or max
The value must be between 1 and 50.
Default: 20
notcontinue

When more results are available, use this to continue.

notunreadfirst

Whether to show unread notifications first (only used if groupbysection is not set).

Type: boolean (details)
nottitles

Only return notifications for these pages. To get notifications not associated with any page, use [] as a title.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
notbundle

Whether to show bundle compatible unread notifications according to notification types bundling rules.

Type: boolean (details)
notnotifiertypes

Notifier types for which to return notifications.

Values (separate with | or alternative): email, web
Default: web
notalertcontinue

When more alert results are available, use this to continue.

notalertunreadfirst

Whether to show unread message notifications first (only used if groupbysection is set).

Type: boolean (details)
notmessagecontinue

When more message results are available, use this to continue.

notmessageunreadfirst

Whether to show unread alert notifications first (only used if groupbysection is set).

Type: boolean (details)
notcrosswikisummary

True to opt in to a summary notification of notifications on foreign wikis.

Type: boolean (details)
Examples:
List web notifications
api.php?action=query&meta=notifications [open in sandbox]
List web notifications, grouped by section, with counts
api.php?action=query&meta=notifications&notprop=count&notsections=alert|message&notgroupbysection=1 [open in sandbox]
List email notifications
api.php?action=query&meta=notifications&notnotifiertypes=email [open in sandbox]

Example[edit]

api.php?action=query&meta=notifications [try in ApiSandbox]
Result
{
    "batchcomplete": "",
    "query": {
        "notifications": {
            "list": [
                {
                    "wiki": "mediawikiwiki",
                    "id": 1367332,
                    "type": "flowusertalk-post-edited",
                    "category": "edit-user-talk",
                    "section": "alert",
                    "timestamp": {
                        "utciso8601": "2021-06-09T20:04:25Z",
                        "utcunix": 1623269065,
                        "unix": "1623269065",
                        "utcmw": "20210609200425",
                        "mw": "20210609200425",
                        "date": "9 June"
                    },
                    "bundledIds": [
                        1367329,
                        1367327,
                        1367307
                    ],
                    "title": {
                        "full": "User talk:APaskulin (WMF)",
                        "namespace": "User_talk",
                        "namespace-key": 3,
                        "text": "APaskulin (WMF)"
                    },
                    "agent": {
                        "id": 906763,
                        "name": "USERNAME"
                    },
                    "targetpages": [],
                    "*": {
                        "header": "A post in \"<strong>\u202aHelp\u202c</strong>\" was edited multiple times on <strong>your talk page</strong>.",
                        "compactHeader": "A post in \"<strong>\u202aHelp\u202c</strong>\" was edited multiple times on <strong>your talk page</strong>.",
                        "body": "Hello, I have a question.",
                        "icon": "flow-post-edited",
                        "links": {
                            "primary": {
                                "url": "https://www.mediawiki.org/w/index.php?title=Topic:W4fwegrqvyipke51&topic_showPostId=wak4fftuljr2os4h&fromnotif=1&markasread=1367332%7C1367329%7C1367327%7C1367307&markasreadwiki=mediawikiwiki#flow-post-wak4fftuljr2os4h",
                                "label": "View post"
                            },
                            "secondary": [
                                {
                                    "url": "https://www.mediawiki.org/wiki/User_talk:APaskulin_(WMF)",
                                    "label": "\u202aAPaskulin (WMF)\u202c",
                                    "tooltip": "User talk:APaskulin (WMF)",
                                    "description": "",
                                    "icon": "userSpeechBubble",
                                    "prioritized": ""
                                }
                            ]
                        },
                        "iconUrl": "/w/extensions/Flow/modules/notification/icon/flow-post-edited-ltr.svg",
                        "bundledIds": [
                            1367329,
                            1367327,
                            1367307
                        ]
                    }
                },
                {
                    "wiki": "mediawikiwiki",
                    "id": 1370891,
                    "type": "flowusertalk-post-reply",
                    "category": "edit-user-talk",
                    "section": "alert",
                    "timestamp": {
                        "utciso8601": "2021-06-17T23:07:22Z",
                        "utcunix": 1623971242,
                        "unix": "1623971242",
                        "utcmw": "20210617230722",
                        "mw": "20210617230722",
                        "date": "17 June"
                    },
                    "bundledIds": [
                        1367323,
                        1367313
                    ],
                    "title": {
                        "full": "User talk:APaskulin (WMF)",
                        "namespace": "User_talk",
                        "namespace-key": 3,
                        "text": "APaskulin (WMF)"
                    },
                    "agent": {
                        "id": 906763,
                        "name": "USERNAME"
                    },
                    "targetpages": [],
                    "*": {
                        "header": "3 new replies on <strong>your talk page</strong> in \"<strong>\u202aHelp\u202c</strong>\".",
                        "compactHeader": "\u202a USERNAME\u202c: <em>Hello!\u00a0:) I don&#039;t know if you have seen the &quot;pastas&quot...</em>.",
                        "body": "",
                        "icon": "edit-user-talk",
                        "links": {
                            "primary": {
                                "url": "https://www.mediawiki.org/w/index.php?title=Topic:W4fwegrqvyipke51&topic_showPostId=wak2hrr30c42csln&fromnotif=1&markasread=1370891%7C1367323%7C1367313&markasreadwiki=mediawikiwiki#flow-post-wak2hrr30c42csln",
                                "label": "View post"
                            },
                            "secondary": [
                                {
                                    "url": "https://www.mediawiki.org/wiki/User_talk:APaskulin_(WMF)",
                                    "label": "\u202aAPaskulin (WMF)\u202c",
                                    "tooltip": "User talk:APaskulin (WMF)",
                                    "description": "",
                                    "icon": "userSpeechBubble",
                                    "prioritized": ""
                                }
                            ]
                        },
                        "iconUrl": "/w/extensions/Echo/modules/icons/edit-user-talk-progressive.svg",
                        "bundledIds": [
                            1367323,
                            1367313
                        ]
                    },
                    "bundledNotifications": [
                        {
                            "wiki": "mediawikiwiki",
                            "id": 1370891,
                            "type": "flowusertalk-post-reply",
                            "category": "edit-user-talk",
                            "section": "alert",
                            "timestamp": {
                                "utciso8601": "2021-06-17T23:07:22Z",
                                "utcunix": 1623971242,
                                "unix": "1623971242",
                                "utcmw": "20210617230722",
                                "mw": "20210617230722",
                                "date": "17 June"
                            },
                            "title": {
                                "full": "User talk:APaskulin (WMF)",
                                "namespace": "User_talk",
                                "namespace-key": 3,
                                "text": "APaskulin (WMF)"
                            },
                            "agent": {
                                "id": 906763,
                                "name": " USERNAME"
                            },
                            "targetpages": [],
                            "*": {
                                "header": "\u202a USERNAME\u202c posted a reply on <strong>your talk page</strong> in \"<strong>\u202aHelp\u202c</strong>\".",
                                "compactHeader": "\u202a USERNAME\u202c: <em>Hello!\u00a0:) I don&#039;t know if you have seen the...",
                                "icon": "edit-user-talk",
                                "links": {
                                    "primary": {
                                        "url": "https://www.mediawiki.org/w/index.php?title=Topic:W4fwegrqvyipke51&topic_showPostId=wb29azkwmbgkaagz&fromnotif=1&markasread=1370891&markasreadwiki=mediawikiwiki#flow-post-wb29azkwmbgkaagz",
                                        "label": "View post"
                                    },
                                    "secondary": [
                                        {
                                            "url": "https://www.mediawiki.org/wiki/User:Klein_Mu%C3%A7i",
                                            "label": "\u202a USERNAME\u202c",
                                            "tooltip": "",
                                            "description": "",
                                            "icon": "userAvatar",
                                            "prioritized": ""
                                        },
                                        {
                                            "url": "https://www.mediawiki.org/wiki/User_talk:APaskulin_(WMF)",
                                            "label": "\u202aAPaskulin (WMF)\u202c",
                                            "tooltip": "User talk:APaskulin (WMF)",
                                            "description": "",
                                            "icon": "userSpeechBubble",
                                            "prioritized": ""
                                        }
                                    ]
                                },
                                "iconUrl": "/w/extensions/Echo/modules/icons/edit-user-talk-progressive.svg"
                            }
                        },
                        {
                            "wiki": "mediawikiwiki",
                            "id": 1367323,
                            "type": "flowusertalk-post-reply",
                            "category": "edit-user-talk",
                            "section": "alert",
                            "timestamp": {
                                "utciso8601": "2021-06-09T19:44:03Z",
                                "utcunix": 1623267843,
                                "unix": "1623267843",
                                "utcmw": "20210609194403",
                                "mw": "20210609194403",
                                "date": "9 June"
                            },
                            "title": {
                                "full": "User talk:APaskulin (WMF)",
                                "namespace": "User_talk",
                                "namespace-key": 3,
                                "text": "APaskulin (WMF)"
                            },
                            "agent": {
                                "id": 906763,
                                "name": " USERNAME"
                            },
                            "targetpages": [],
                            "*": {
                                "header": "\u202a USERNAME\u202c posted a reply on <strong>your talk page</strong> in \"<strong>\u202aHelp\u202c</strong>\".",
                                "compactHeader": "\u202a USERNAME\u202c: <em>I hope this makes it work.",
                                "icon": "edit-user-talk",
                                "links": {
                                    "primary": {
                                        "url": "https://www.mediawiki.org/w/index.php?title=Topic:W4fwegrqvyipke51&topic_showPostId=wak4fftuljr2os4h&fromnotif=1&markasread=1367323&markasreadwiki=mediawikiwiki#flow-post-wak4fftuljr2os4h",
                                        "label": "View post"
                                    },
                                    "secondary": [
                                        {
                                            "url": "https://www.mediawiki.org/wiki/User:Klein_Mu%C3%A7i",
                                            "label": "\u202a USERNAME\u202c",
                                            "tooltip": "",
                                            "description": "",
                                            "icon": "userAvatar",
                                            "prioritized": ""
                                        },
                                        {
                                            "url": "https://www.mediawiki.org/wiki/User_talk:APaskulin_(WMF)",
                                            "label": "\u202aAPaskulin (WMF)\u202c",
                                            "tooltip": "User talk:APaskulin (WMF)",
                                            "description": "",
                                            "icon": "userSpeechBubble",
                                            "prioritized": ""
                                        }
                                    ]
                                },
                                "iconUrl": "/w/extensions/Echo/modules/icons/edit-user-talk-progressive.svg"
                            }
                        },
                        {
                            "wiki": "mediawikiwiki",
                            "id": 1367313,
                            "type": "flowusertalk-post-reply",
                            "category": "edit-user-talk",
                            "section": "alert",
                            "timestamp": {
                                "utciso8601": "2021-06-09T19:09:29Z",
                                "utcunix": 1623265769,
                                "unix": "1623265769",
                                "utcmw": "20210609190929",
                                "mw": "20210609190929",
                                "date": "9 June"
                            },
                            "title": {
                                "full": "User talk:APaskulin (WMF)",
                                "namespace": "User_talk",
                                "namespace-key": 3,
                                "text": "APaskulin (WMF)"
                            },
                            "agent": {
                                "id": 906763,
                                "name": " USERNAME"
                            },
                            "targetpages": [],
                            "*": {
                                "header": "\u202a USERNAME\u202c posted a reply on <strong>your talk page</strong> in \"<strong>\u202aHelp\u202c</strong>\".",
                                "compactHeader": "\u202a USERNAME\u202c: <em>Reuploaded them all and updated the links above...",
                                "icon": "edit-user-talk",
                                "links": {
                                    "primary": {
                                        "url": "https://www.mediawiki.org/w/index.php?title=Topic:W4fwegrqvyipke51&topic_showPostId=wak2hrr30c42csln&fromnotif=1&markasread=1367313&markasreadwiki=mediawikiwiki#flow-post-wak2hrr30c42csln",
                                        "label": "View post"
                                    },
                                    "secondary": [
                                        {
                                            "url": "https://www.mediawiki.org/wiki/User:Klein_Mu%C3%A7i",
                                            "label": "\u202a USERNAME\u202c",
                                            "tooltip": "",
                                            "description": "",
                                            "icon": "userAvatar",
                                            "prioritized": ""
                                        },
                                        {
                                            "url": "https://www.mediawiki.org/wiki/User_talk:APaskulin_(WMF)",
                                            "label": "\u202aAPaskulin (WMF)\u202c",
                                            "tooltip": "User talk:APaskulin (WMF)",
                                            "description": "",
                                            "icon": "userSpeechBubble",
                                            "prioritized": ""
                                        }
                                    ]
                                },
                                "iconUrl": "/w/extensions/Echo/modules/icons/edit-user-talk-progressive.svg"
                            }
                        }
                    ]
                }
            ],
            "continue": "1621295145|1357008",
            "rawcount": 25,
            "count": "25",
            "seenTime": {
                "alert": "2021-08-31T20:17:56Z",
                "message": "2021-06-09T02:55:22Z"
            }
        }
    }
}

action=echomarkread

(main | echomarkread)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: Echo
  • License: MIT

Mark notifications as read for the current user.

Parameters:
wikis

List of wikis to mark notification as read (defaults to only current wiki).

Values (separate with | or alternative): *, aawiki, aawikibooks, aawiktionary, abwiki, abwiktionary, acewiki, advisorswiki, advisorywiki, adywiki, afwiki, afwikibooks, afwikiquote, afwiktionary, akwiki, akwikibooks, akwiktionary, alswiki, altwiki, amiwiki, amwiki, amwikimedia, amwikiquote, amwiktionary, angwiki, angwikibooks, angwikiquote, angwikisource, angwiktionary, anwiki, anwiktionary, apiportalwiki, arbcom_cswiki, arbcom_dewiki, arbcom_enwiki, arbcom_fiwiki, arbcom_nlwiki, arbcom_ruwiki, arcwiki, arwiki, arwikibooks, arwikimedia, arwikinews, arwikiquote, arwikisource, arwikiversity, arwiktionary, arywiki, arzwiki, astwiki, astwikibooks, astwikiquote, astwiktionary, aswiki, aswikibooks, aswikisource, aswiktionary, atjwiki, auditcomwiki, avkwiki, avwiki, avwiktionary, awawiki, aywiki, aywikibooks, aywiktionary, azbwiki, azwiki, azwikibooks, azwikiquote, azwikisource, azwiktionary, banwiki, banwikisource, barwiki, bat_smgwiki, bawiki, bawikibooks, bclwiki, bclwiktionary, bdwikimedia, be_x_oldwiki, betawikiversity, bewiki, bewikibooks, bewikimedia, bewikiquote, bewikisource, bewiktionary, bgwiki, bgwikibooks, bgwikinews, bgwikiquote, bgwikisource, bgwiktionary, bhwiki, bhwiktionary, biwiki, biwikibooks, biwiktionary, bjnwiki, bmwiki, bmwikibooks, bmwikiquote, bmwiktionary, bnwiki, bnwikibooks, bnwikisource, bnwikivoyage, bnwiktionary, boardgovcomwiki, boardwiki, bowiki, bowikibooks, bowiktionary, bpywiki, brwiki, brwikimedia, brwikiquote, brwikisource, brwiktionary, bswiki, bswikibooks, bswikinews, bswikiquote, bswikisource, bswiktionary, bugwiki, bxrwiki, cawiki, cawikibooks, cawikimedia, cawikinews, cawikiquote, cawikisource, cawiktionary, cbk_zamwiki, cdowiki, cebwiki, cewiki, chairwiki, chapcomwiki, checkuserwiki, chowiki, chrwiki, chrwiktionary, chwiki, chwikibooks, chwiktionary, chywiki, ckbwiki, cnwikimedia, collabwiki, commonswiki, cowiki, cowikibooks, cowikimedia, cowikiquote, cowiktionary, crhwiki, crwiki, crwikiquote, crwiktionary, csbwiki, csbwiktionary, cswiki, cswikibooks, cswikinews, cswikiquote, cswikisource, cswikiversity, cswiktionary, cuwiki, cvwiki, cvwikibooks, cywiki, cywikibooks, cywikiquote, cywikisource, cywiktionary, dagwiki, dawiki, dawikibooks, dawikiquote, dawikisource, dawiktionary, dewiki, dewikibooks, dewikinews, dewikiquote, dewikisource, dewikiversity, dewikivoyage, dewiktionary, dinwiki, diqwiki, diqwiktionary, dkwikimedia, donatewiki, dsbwiki, dtywiki, dvwiki, dvwiktionary, dzwiki, dzwiktionary, ecwikimedia, eewiki, electcomwiki, elwiki, elwikibooks, elwikinews, elwikiquote, elwikisource, elwikiversity, elwikivoyage, elwiktionary, emlwiki, enwiki, enwikibooks, enwikinews, enwikiquote, enwikisource, enwikiversity, enwikivoyage, enwiktionary, eowiki, eowikibooks, eowikinews, eowikiquote, eowikisource, eowikivoyage, eowiktionary, eswiki, eswikibooks, eswikinews, eswikiquote, eswikisource, eswikiversity, eswikivoyage, eswiktionary, etwiki, etwikibooks, etwikimedia, etwikiquote, etwikisource, etwiktionary, euwiki, euwikibooks, euwikiquote, euwikisource, euwiktionary, execwiki, extwiki, fawiki, fawikibooks, fawikinews, fawikiquote, fawikisource, fawikivoyage, fawiktionary, fdcwiki, ffwiki, fiu_vrowiki, fiwiki, fiwikibooks, fiwikimedia, fiwikinews, fiwikiquote, fiwikisource, fiwikiversity, fiwikivoyage, fiwiktionary, fjwiki, fjwiktionary, foundationwiki, fowiki, fowikisource, fowiktionary, frpwiki, frrwiki, frwiki, frwikibooks, frwikinews, frwikiquote, frwikisource, frwikiversity, frwikivoyage, frwiktionary, furwiki, fywiki, fywikibooks, fywiktionary, gagwiki, ganwiki, gawiki, gawikibooks, gawikiquote, gawiktionary, gcrwiki, gdwiki, gdwiktionary, gewikimedia, glkwiki, glwiki, glwikibooks, glwikiquote, glwikisource, glwiktionary, gnwiki, gnwikibooks, gnwiktionary, gomwiki, gomwiktionary, gorwiki, gotwiki, gotwikibooks, grantswiki, grwikimedia, guwiki, guwikibooks, guwikiquote, guwikisource, guwiktionary, guwwiki, gvwiki, gvwiktionary, hakwiki, hawiki, hawiktionary, hawwiki, hewiki, hewikibooks, hewikinews, hewikiquote, hewikisource, hewikivoyage, hewiktionary, hifwiki, hifwiktionary, hiwiki, hiwikibooks, hiwikimedia, hiwikiquote, hiwikisource, hiwikiversity, hiwikivoyage, hiwiktionary, howiki, hrwiki, hrwikibooks, hrwikiquote, hrwikisource, hrwiktionary, hsbwiki, hsbwiktionary, htwiki, htwikisource, huwiki, huwikibooks, huwikinews, huwikiquote, huwikisource, huwiktionary, hywiki, hywikibooks, hywikiquote, hywikisource, hywiktionary, hywwiki, hzwiki, iawiki, iawikibooks, iawiktionary, id_internalwikimedia, idwiki, idwikibooks, idwikimedia, idwikiquote, idwikisource, idwiktionary, iegcomwiki, iewiki, iewikibooks, iewiktionary, igwiki, iiwiki, ikwiki, ikwiktionary, ilowiki, ilwikimedia, incubatorwiki, inhwiki, internalwiki, iowiki, iowiktionary, iswiki, iswikibooks, iswikiquote, iswikisource, iswiktionary, itwiki, itwikibooks, itwikinews, itwikiquote, itwikisource, itwikiversity, itwikivoyage, itwiktionary, iuwiki, iuwiktionary, jamwiki, jawiki, jawikibooks, jawikinews, jawikiquote, jawikisource, jawikiversity, jawikivoyage, jawiktionary, jbowiki, jbowiktionary, jvwiki, jvwikisource, jvwiktionary, kaawiki, kabwiki, kawiki, kawikibooks, kawikiquote, kawiktionary, kbdwiki, kbpwiki, kcgwiki, kgwiki, kiwiki, kjwiki, kkwiki, kkwikibooks, kkwikiquote, kkwiktionary, klwiki, klwiktionary, kmwiki, kmwikibooks, kmwiktionary, knwiki, knwikibooks, knwikiquote, knwikisource, knwiktionary, koiwiki, kowiki, kowikibooks, kowikinews, kowikiquote, kowikisource, kowikiversity, kowiktionary, krcwiki, krwiki, krwikiquote, kshwiki, kswiki, kswikibooks, kswikiquote, kswiktionary, kuwiki, kuwikibooks, kuwikiquote, kuwiktionary, kvwiki, kwwiki, kwwikiquote, kwwiktionary, kywiki, kywikibooks, kywikiquote, kywiktionary, labswiki, labtestwiki, ladwiki, lawiki, lawikibooks, lawikiquote, lawikisource, lawiktionary, lbewiki, lbwiki, lbwikibooks, lbwikiquote, lbwiktionary, legalteamwiki, lezwiki, lfnwiki, lgwiki, lijwiki, lijwikisource, liwiki, liwikibooks, liwikinews, liwikiquote, liwikisource, liwiktionary, lldwiki, lmowiki, lmowiktionary, lnwiki, lnwikibooks, lnwiktionary, loginwiki, lowiki, lowiktionary, lrcwiki, ltgwiki, ltwiki, ltwikibooks, ltwikiquote, ltwikisource, ltwiktionary, lvwiki, lvwikibooks, lvwiktionary, madwiki, maiwiki, maiwikimedia, map_bmswiki, mdfwiki, mediawikiwiki, metawiki, mgwiki, mgwikibooks, mgwiktionary, mhrwiki, mhwiki, mhwiktionary, minwiki, minwiktionary, miwiki, miwikibooks, miwiktionary, mkwiki, mkwikibooks, mkwikimedia, mkwikisource, mkwiktionary, mlwiki, mlwikibooks, mlwikiquote, mlwikisource, mlwiktionary, mniwiki, mniwiktionary, mnwiki, mnwikibooks, mnwiktionary, mnwwiki, mnwwiktionary, movementroleswiki, mrjwiki, mrwiki, mrwikibooks, mrwikiquote, mrwikisource, mrwiktionary, mswiki, mswikibooks, mswiktionary, mtwiki, mtwiktionary, muswiki, mwlwiki, mxwikimedia, myvwiki, mywiki, mywikibooks, mywiktionary, mznwiki, nahwiki, nahwikibooks, nahwiktionary, napwiki, napwikisource, nawiki, nawikibooks, nawikiquote, nawiktionary, nds_nlwiki, ndswiki, ndswikibooks, ndswikiquote, ndswiktionary, newiki, newikibooks, newiktionary, newwiki, ngwiki, ngwikimedia, niawiki, niawiktionary, nlwiki, nlwikibooks, nlwikimedia, nlwikinews, nlwikiquote, nlwikisource, nlwikivoyage, nlwiktionary, nnwiki, nnwikiquote, nnwiktionary, noboard_chapterswikimedia, nostalgiawiki, novwiki, nowiki, nowikibooks, nowikimedia, nowikinews, nowikiquote, nowikisource, nowiktionary, nqowiki, nrmwiki, nsowiki, nvwiki, nycwikimedia, nywiki, nzwikimedia, ocwiki, ocwikibooks, ocwiktionary, officewiki, olowiki, ombudsmenwiki, omwiki, omwiktionary, orwiki, orwikisource, orwiktionary, oswiki, otrs_wikiwiki, outreachwiki, pa_uswikimedia, pagwiki, pamwiki, papwiki, pawiki, pawikibooks, pawikisource, pawiktionary, pcdwiki, pdcwiki, pflwiki, pihwiki, piwiki, piwiktionary, plwiki, plwikibooks, plwikimedia, plwikinews, plwikiquote, plwikisource, plwikivoyage, plwiktionary, pmswiki, pmswikisource, pnbwiki, pnbwiktionary, pntwiki, projectcomwiki, pswiki, pswikibooks, pswikivoyage, pswiktionary, ptwiki, ptwikibooks, ptwikimedia, ptwikinews, ptwikiquote, ptwikisource, ptwikiversity, ptwikivoyage, ptwiktionary, punjabiwikimedia, pwnwiki, qualitywiki, quwiki, quwikibooks, quwikiquote, quwiktionary, rmwiki, rmwikibooks, rmwiktionary, rmywiki, rnwiki, rnwiktionary, roa_rupwiki, roa_rupwiktionary, roa_tarawiki, romdwikimedia, rowiki, rowikibooks, rowikinews, rowikiquote, rowikisource, rowikivoyage, rowiktionary, rswikimedia, ruewiki, ruwiki, ruwikibooks, ruwikimedia, ruwikinews, ruwikiquote, ruwikisource, ruwikiversity, ruwikivoyage, ruwiktionary, rwwiki, rwwiktionary, sahwiki, sahwikiquote, sahwikisource, satwiki, sawiki, sawikibooks, sawikiquote, sawikisource, sawiktionary, scnwiki, scnwiktionary, scowiki, scwiki, scwiktionary, sdwiki, sdwikinews, sdwiktionary, searchcomwiki, sewiki, sewikibooks, sewikimedia, sgwiki, sgwiktionary, shiwiki, shnwiki, shnwikivoyage, shnwiktionary, shwiki, shwiktionary, shywiktionary, simplewiki, simplewikibooks, simplewikiquote, simplewiktionary, siwiki, siwikibooks, siwiktionary, skrwiki, skrwiktionary, skwiki, skwikibooks, skwikiquote, skwikisource, skwiktionary, slwiki, slwikibooks, slwikiquote, slwikisource, slwikiversity, slwiktionary, smnwiki, smwiki, smwiktionary, snwiki, snwiktionary, sourceswiki, sowiki, sowiktionary, spcomwiki, specieswiki, sqwiki, sqwikibooks, sqwikinews, sqwikiquote, sqwiktionary, srnwiki, srwiki, srwikibooks, srwikinews, srwikiquote, srwikisource, srwiktionary, sswiki, sswiktionary, stewardwiki, stqwiki, strategywiki, stwiki, stwiktionary, suwiki, suwikibooks, suwikiquote, suwiktionary, svwiki, svwikibooks, svwikinews, svwikiquote, svwikisource, svwikiversity, svwikivoyage, svwiktionary, swwiki, swwikibooks, swwiktionary, sysop_itwiki, szlwiki, szywiki, tawiki, tawikibooks, tawikinews, tawikiquote, tawikisource, tawiktionary, taywiki, tcywiki, techconductwiki, tenwiki, test2wiki, testcommonswiki, testwiki, testwikidatawiki, tetwiki, tewiki, tewikibooks, tewikiquote, tewikisource, tewiktionary, tgwiki, tgwikibooks, tgwiktionary, thankyouwiki, thwiki, thwikibooks, thwikinews, thwikiquote, thwikisource, thwiktionary, tiwiki, tiwiktionary, tkwiki, tkwikibooks, tkwikiquote, tkwiktionary, tlwiki, tlwikibooks, tlwiktionary, tnwiki, tnwiktionary, towiki, towiktionary, tpiwiki, tpiwiktionary, transitionteamwiki, trvwiki, trwiki, trwikibooks, trwikimedia, trwikinews, trwikiquote, trwikisource, trwikivoyage, trwiktionary, tswiki, tswiktionary, ttwiki, ttwikibooks, ttwikiquote, ttwiktionary, tumwiki, twwiki, twwiktionary, tyvwiki, tywiki, uawikimedia, udmwiki, ugwiki, ugwikibooks, ugwikiquote, ugwiktionary, ukwiki, ukwikibooks, ukwikinews, ukwikiquote, ukwikisource, ukwikivoyage, ukwiktionary, urwiki, urwikibooks, urwikiquote, urwiktionary, usabilitywiki, uzwiki, uzwikibooks, uzwikiquote, uzwiktionary, vecwiki, vecwikisource, vecwiktionary, vepwiki, vewiki, viwiki, viwikibooks, viwikiquote, viwikisource, viwikivoyage, viwiktionary, vlswiki, votewiki, vowiki, vowikibooks, vowikiquote, vowiktionary, warwiki, wawiki, wawikibooks, wawikisource, wawiktionary, wbwikimedia, wg_enwiki, wikidatawiki, wikimania2005wiki, wikimania2006wiki, wikimania2007wiki, wikimania2008wiki, wikimania2009wiki, wikimania2010wiki, wikimania2011wiki, wikimania2012wiki, wikimania2013wiki, wikimania2014wiki, wikimania2015wiki, wikimania2016wiki, wikimania2017wiki, wikimania2018wiki, wikimaniateamwiki, wikimaniawiki, wowiki, wowikiquote, wowiktionary, wuuwiki, xalwiki, xhwiki, xhwikibooks, xhwiktionary, xmfwiki, yiwiki, yiwikisource, yiwiktionary, yowiki, yowikibooks, yowiktionary, yuewiktionary, zawiki, zawikibooks, zawikiquote, zawiktionary, zeawiki, zh_classicalwiki, zh_min_nanwiki, zh_min_nanwikibooks, zh_min_nanwikiquote, zh_min_nanwikisource, zh_min_nanwiktionary, zh_yuewiki, zhwiki, zhwikibooks, zhwikinews, zhwikiquote, zhwikisource, zhwikiversity, zhwikivoyage, zhwiktionary, zuwiki, zuwikibooks, zuwiktionary
Maximum number of values is 50 (500 for clients allowed higher limits).
Default: mediawikiwiki
list

A list of notification IDs to mark as read.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
unreadlist

A list of notification IDs to mark as unread.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
all

If set, marks all of a user's notifications as read.

Type: boolean (details)
sections

A list of sections to mark as read.

Values (separate with | or alternative): alert, message
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.
Examples:
Mark notification 8 as read
api.php?action=echomarkread&list=8 [open in sandbox]
Mark all notifications as read
api.php?action=echomarkread&all=true [open in sandbox]
Mark notification 1 as unread
api.php?action=echomarkread&unreadlist=1 [open in sandbox]

Example[edit]

Note: In this example, all parameters are passed in a GET request just for the sake of simplicity. However, action=echomarkread requires POST requests.

api.php?action=echomarkread&all=1&token=TOKEN [try in ApiSandbox]
Result
{
    "query": {
        "echomarkread": {
            "result": "success",
            "rawcount": 0,
            "count": "0"
        }
    }
}

action=echomarkseen

(main | echomarkseen)
  • This module requires read rights.
  • Source: Echo
  • License: MIT

Mark notifications as seen for the current user.

Parameters:
type

Type of notifications to mark as seen: 'alert', 'message' or 'all'.

This parameter is required.
One of the following values: alert, all, message
timestampFormat

Timestamp format to use for output, 'ISO_8601' or 'MW'. 'MW' is deprecated here, so all clients should switch to 'ISO_8601'. This parameter will be removed, and 'ISO_8601' will become the only output format.

One of the following values: ISO_8601, MW
Default: MW
Example:
Mark notifications of all types as seen
api.php?action=echomarkseen&type=all [open in sandbox]
Retrieved from "https://www.mediawiki.org/w/index.php?title=Notifications/API&oldid=4791047"