Skip to main content

Update User

The UPDATE_USER event is triggered whenever a user's basic information is updated. It is sent to every organization that has an active case for that user, and the payload always contains the latest user information.

The event fires when any of the following monitored fields change:

  • Email
  • Phone Number
  • First Name
  • Last Name
  • Date of Birth (DOB)
  • Gender
  • isDeleted

Attributes​

eventstring
The name of the event that was triggered. For this webhook, the value will always be `UPDATE_USER`.
payloadobject
The main object containing all data related to the user update event.
Show child attributes
userobject
An object containing the latest information of the user whose details were updated.
Show child attributes
idstring
The unique identifier of the user.
emailstring
The email address of the user.
firstNamestring
The first name of the user.
lastNamestring
The last name of the user.
dobstring<date-time> | null
The date of birth of the user in ISO 8601 format. `null` if not set.
phoneNumberstring | null
The phone number of the user, including country code. `null` if not set.
genderstring | null
The gender of the user (e.g., MALE, FEMALE, OTHER). `null` if not set.
isDeletedboolean
Indicates whether the user has been deleted. `true` when the user was removed.

Response​

{
  "event": "UPDATE_USER",
  "payload": {
    "user": {
      "id": "a9a2bJ9VcoVEPGgK9REMkjKIbl33",
      "email": "john@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "dob": "1990-12-12T00:00:00.000Z",
      "phoneNumber": "+12284746464",
      "gender": "MALE",
      "isDeleted": false
    }
  }
}