Skip to main content

Invitation created

The event is created when an invitation email link is created.

ParameterTypeDescription
namestringuser.invitation.created
descriptionstringInvitation created
user.idstringThe ID of the user
user.loginIdstringThe login ID of the user
user.firstNamestringThe first name of the user
user.lastNamestringThe last name of the user
user.statestringThe state of the user
user.languageCodestringThe language of the user
user.propertiesobjectThe custom properties the user

Example event

{
"actor": {
"loginId": "your_application_api_user",
"userAgent": "curl/7.68.0",
"id": "54f3bfc2-6c37-4528-b8a3-ff8c1b1bbcf5",
"type": "api"
},
"eventId": "baaa0fcd-b388-11ed-9a82-000d3aabadd6",
"name": "user.invitation.created",
"description": "Invitation created",
"user": {
"firstName": "Abigail",
"lastName": "Mackay",
"loginId": "[email protected]",
"id": "d7601cea-f869-41e4-b090-32bb6bdb8cd2",
"languageCode": "en",
"state": "active",
"properties": {
"preferredContactChannel": "email"
}
},
"timestamp": "2023-02-23T14:45:16.293Z",
"status": "succeeded"
}