There are some extra fields that will be added to this area as part of the new HR update. Below is the current representation of a Webhook data payload for a person.
|
Person Template |
{ "id": <int>, "givenName": <string>, "familyName": <string>, "knownAs": <string>, "gender": <string>, "dateOfBirth": <string ISO 8601 Date>, "nationality": <string>, "timeZone": <string>, "contactDetails": { "email": <string>, "dialingCode": <string – international dialing code (+XX) >, "mobile": <string>, "telephone": <string> }, "address": { "addressLine1": <string>, "addressLine2": <string>, "town": <string>, "country": <string> "postCode": <string> }, "emergencyContact": { "emergencyContactName": <string>, "emergencyContactTelephone":<string>, "emergencyRelationshipId": <int>, "emergencyContactConsent": <bool> }, "employeeDetails": { "employeeStatus": <string>, "tag": <string> "startDate": <string ISO 8601 Date>, "tenure": <int>, "role": <string>", "teams": [<string>], "skills": [<string>], "externalIds": [<string>], "siteId": <int>, "siteName": <string>", "departmentId": <int>, "departmentName": <string>, "manager": { "id": <int>, "name": <string> } }, "isActive": <bool – has user verified the account>, "accountStatus": <int> }
|
Json Schema (For use with MS Power Automate)
{
"type": "object",
"properties": {
"subjectType": {
"type": "string"
},
"changeType": {
"type": "string"
},
"subjectFrontEndUrl": {
"type": "string"
},
"timeStamp": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"givenName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"familyName": {
"type": "string"
},
"knownAs": {
"type": "string"
},
"gender": {
"type": "string"
},
"ethnicity": {
"type": "string"
},
"dateOfBirth": {
"type": "string"
},
"nationality": {
"type": "string"
},
"contactDetails": {
"type": "object",
"properties": {
"personalEmail": {
"type": "string"
},
"workEmail": {
"type": "string"
},
"dialingCode": {
"type": "string"
},
"personalMobile": {
"type": "string"
},
"homeTelephone": {
"type": "string"
},
"workTelephone": {
"type": "string"
},
"workExtension": {
"type": "string"
}
}
},
"address": {
"type": "object",
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"town": {
"type": "string"
},
"country": {
"type": "string"
},
"postCode": {
"type": "string"
}
}
},
"emergencyContact": {
"type": "object",
"properties": {
"emergencyContactName": {
"type": "string"
},
"emergencyContactTelephone": {
"type": "string"
},
"emergencyRelationshipId": {
"type": "integer"
},
"emergencyContactConsent": {
"type": "boolean"
},
"emergencyAddress": {
"type": "string"
},
"emergencyMedicalNotes": {
"type": "string"
}
}
},
"nextOfKin": {
"type": "object",
"properties": {
"Name": {},
"Telephone": {
"type": "string"
},
"RelationshipId": {}
}
},
"employeeDetails": {
"type": "object",
"properties": {
"employeeStatus": {
"type": "string"
},
"employmentType": {
"type": "string"
},
"employmentNotes": {
"type": "string"
},
"tag": {
"type": "string"
},
"startDate": {
"type": "string"
},
"tenure": {
"type": "integer"
},
"role": {
"type": "string"
},
"teams": {
"type": "array"
},
"skills": {
"type": "array"
},
"externalIds": {
"type": "array"
},
"siteId": {
"type": "integer"
},
"siteName": {
"type": "string"
},
"departmentId": {
"type": "integer"
},
"departmentName": {
"type": "string"
},
"manager": {
"type": "object",
"properties": {
"PersonId": {
"type": "integer"
},
"FirstName": {
"type": ["null", "string"]
},
"FamilyName": {
"type": ["null", "string"]
},
"Email": {
"type": ["null", "string"]
}
}
}
}
},
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"createdByPerson": {
"type": "object",
"properties": {
"PersonId": {
"type": "integer"
},
"FirstName": {
"type": ["null", "string"]
},
"FamilyName": {
"type": ["null", "string"]
},
"Email": {
"type": ["null", "string"]
}
}
},
"modifiedByPerson": {
"type": "object",
"properties": {
"PersonId": {
"type": "integer"
},
"FirstName": {
"type": ["null", "string"]
},
"FamilyName": {
"type": ["null", "string"]
},
"Email": {
"type": ["null", "string"]
}
}
},
"isActive": {
"type": "boolean"
},
"accountStatus": {
"type": "integer"
}
}
},
"differences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"oldValue": {
"type": "string"
},
"newValue": {
"type": "string"
}
},
"required": [
"path",
"oldValue",
"newValue"
]
}
}
}
}