Extension:EventBus

The EventBus extension propagates state changes (edit, move, delete, revision visibility, etc) to a RESTful event service, providing consumers of the service with the means of tracking changes to MediaWiki content.

Known Issues
Ideally, this sort of change propagation would be atomic, that is to say, if one of the tracked changes is committed in MediaWiki, the corresponding event is guaranteed to be delivered (even if by eventual consistency). As this extension is hook-based, that is not currently the case; Truly reliable event delivery will likely require something bound to the corresponding database transaction. (tracked in .)

Download / Install

 * To enable, add the following code to the bottom of your :


 * ✅; Navigate to 'Special:Version' on your wiki, and verify the extension is successfully installed

Run Job REST API
The Run Job REST API allows you to execute a job using a REST API endpoint. To enable the Run Job REST API on your wiki, configure LocalSettings.php with the and $wgEventBusEnableRunJobAPI settings. The Run Job REST API is compatible with MediaWiki 1.34 and later.

Run job
Route:

Method:

Content-Type: application/json

Submits a job for execution by the event service. This endpoint is released under ; it should be considered unstable and may change in backwards incompatible ways without notice.

Request example

Request parameters

Here are the minimum parameters required by the endpoint. The full schema of a job can be found in the mediawiki-event-schemas directory.

Responses

Response schema

Configuration
Note: For this extension to be useful, you need to be running an event service.

To configure the event service, add the following to your, (setting the event service name and URL value according to your environment.

API configuration
To enable the Run Job REST API, add the following to your.