abstract swish line in gradient colouring from pink to blue on a dark blue background

Event stream documentation

PersonCreated and PersonNameChanged event

A PersonCreated event will be raised when:

  • a person is created in hrm
  • a person is onboarded into hrm via recruitment

A PersonNameChanged event will be raised when:

  • any property of a person's name is changed in hrm

Field definitions for this event;

Field NameData TypeAdditional information
personIdguidn/a
personalReferencestringmax-length: 20
firstNamestringmax-length: 80
lastNamestringmax-length: 80
otherNamesstringmax-length: 160
knownAsstringmax-length: 80
previousLastNamestringmax-length: 80
titleCodestringmax-length: 40; reference-data


Example of this event

{
  "personId": "",
  "personalReference": "",
  "firstName": "",
  "lastName": "",
  "otherNames": "",
  "knownAs": "",
  "previousLastName": "",
  "titleCode": ""
}

PersonDeleted event

A PersonDeleted event will be raised when:

  • a person is deleted from hrm

Field definitions for this event;

Field NameData TypeAdditional information
personIdguidn/a
personalReferencestringmax-length: 20


Example of this event

{
"personId": "",
"personalReference": ""
}

PersonAddressCreated and PersonAddressChanged event

A PersonAddressCreated event will be raised when:

  • the first address is created in hrm

A PersonAddressChanged event will be raised when:

  • any property of a person's address is changed in hrm

Field definitions for this event;

Field NameData TypeAdditional information
personIdguidn/a
personalReferencestringmax-length: 20
addressLine1stringmax-length: 80
addressLine2stringmax-length: 80
addressLine3stringmax-length: 80
addressLine4stringmax-length: 80
addressLine5stringmax-length: 80
addressLine6stringmax-length: 80
countryCodestringmax-length: 40; reference-data


Example of this event

{
  "personId": "",
  "personalReference": "",
  "addressLine1": "",
  "addressLine2": "",
  "addressLine3": "",
  "addressLine4": "",
  "addressLine5": "",
  "addressLine6": "",
  "countryCode": ""
}

PersonContactDetailCreated and PersonContactDetailChanged event

A PersonContactDetailCreated event will be raised when:

  • a person's contact details are edited for a first time in hrm

A PersonContactDetailChanged event will be raised when:

  • a person's contact details are updated

Field definitions for this event;

Field NameData TypeAdditional information
personIdguidn/a
contactTypestringmax-length: 40; reference-data
contactDetailstringmax-length: 80. Depending on the contactType, field contains an email or phone number.
internationalDialingCodestringmax-length: 160


Example of this event

{
                    "personId": "",
                    "contactType": "",
                    "contactDetail": "",
                    "internationalDialingCode": ""
                    }

Looking for something specific?