Event stream documentation

As with the other People First APIs, consumers of the Event Stream API will need to be aware of the type of changes that are considered to be backwards compatible, and will need to code their applications to handle them. This applies equally to consumers of the Event Stream REST API and consumers of Event Stream Webhook requests. Further details are available here.

Webhooks

Overview

People First can be configured to send event stream data to external systems. This is commonly used to satisfy real time systems integration requirements. Webhooks can be configured for any event type and are digitally signed for security. For details of how to configure and verify webhooks see: Webhook API Integration.

Webhook request payload

When a webhook POST request is issued, the event stream data is included in the http request body. The payload also includes the eventType and the timeOfCreation. A sample webhook request payload is shown below.

Sample webhook request payload for occupancySalaryTimelineChanged

{
  "EventData": {
    "occupancyId": "763b6741-9435-4af7-8936-a9b30101f38e",
    "personalReference": "TT1136",
    "jobReference": "TR0001",
    "startDate": "2001-01-01",
    "endDate": null,
    "salaryRevisions": [
      {
        "startDate": "2001-01-01",
        "endDate": null,
        "rateOfPay": 10000,
        "frequencyCode": "A"
      }
    ]
  },
  "EventType": "OccupancySalaryTimelineChanged",
  "TimeOfCreation": "2020-04-06T08:16:05.034765Z"
}