Your workplace needs more WOW. Get ready for MHR's World of Work 2026
Image
Introduction
People First captures many events that occur as a result of business actions within the system (e.g. a person being created, an absence being deleted, etc.). These events are stored and exposed via an event stream api. The api contains events from multiple microservices within people first. The event stream enables consumers to identify exactly what has happened in the system and when it happened. Its purpose is for systems integration: to facilitate the synchronisation of information between multiple software systems. It is not an audit facility as it does not record all events, nor does it always record before and after information.
Accessing the Event Stream API
Like all People First APIs, the Event Stream API requires authentication in order for an application to access it and make API calls. This is achieved in three parts:
Application Configuration
In order to acquire an access token and access the event stream api, the following tasks need to be carried out:
- An application needs to be configured within People First.
- An access token, permissioned with the appropriate role, needs to be acquired for that application.
For details of how to do this, please refer to the REST API Integration section in the main API documentation.
Application Authentication
An API client authenticates itself with the Event Stream service by providing a valid token within the Authorization header of each HTTP request. For details of how to do this, please refer to the Authentication section in the main API documentation.
API Authorisation
In order to access People First events via the Event Stream API, you will need an access token that has been granted the "System Integration" role.
Event Stream API
The Event Stream API is comprised of a single RESTful endpoint. The endpoint takes the form:
PEOPLE_FIRST_BASE_URI/api/v1/rtpi/eventstreamWhere:
PEOPLE_FIRST_BASE_URIis the base URI for your People First system (see: API Requests).
Please refer to the API Requests section in the main API documentation for details of how to construct a People First API request.
In addition to the following query parameters, the Event Stream API also supports the pagination of results (see: Pagination).
| Input type | Name | Description | Required |
|---|---|---|---|
| Querystring | eventTypes | Events of this type will be included in the response. Multiple event types can be provided as separate querystring parameters (e.g. eventTypes=SalaryChanged&eventTypes=PersonNameChanged). | Optional |
| Querystring | timeOfCreationFrom | Events created on or after this dateTime will be included in the response. The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) | Optional |
| Querystring | timeOfCreationTo | Events created on or before this dateTime will be included in the response. The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) | Optional |
| Querystring | timeOfReceiptFrom | Events received by the event stream on or after this dateTime will be included in the response. The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) | Optional |
| Querystring | timeOfReceiptTo | Events received by the event stream on or before this dateTime will be included in the response. The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z) | Optional |
