MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=echocreateevent
(main | echocreateevent)
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: Echo
- License: MIT
Manually trigger a notification to a user
Specific parameters:
Other general parameters are available.
- user
User to send the notification to
- Type: user, by any of username and user ID (e.g. "#12345")
- header
Header content of the notification
- This parameter is required.
- Cannot be longer than 160 bytes.
- content
Body content of the notification
- This parameter is required.
- Cannot be longer than 5,000 bytes.
- page
Page to link to in the notification
- Type: page title
- Accepts non-existent pages.
- section
Section where notification would be delivered
- This parameter is required.
- One of the following values: alert, notice
- Default: notice
Whether to send an email as well
- Type: boolean (details)
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
Example:
- Send a notification
- api.php?action=echocreateevent&header=Hi&content=From_API [open in sandbox]