Skip to main content

Customer Profile Update Event

POST 
/profile/events

This webhook is triggered whenever a profile update request is made. It includes the customer's information along with details about the changes made during the update.

The changes object in the request body is an array of objects representing individual profile changes.

Properties of a Change Object:​

  • field: The flat path to the updated part of the user profile.
  • status: The status of the operation (SUCCESS or FAIL).
  • oldValue: The previous value of the updated field.
  • newValue: The desired value of the field after the update.
  • errorMessages (optional): An array of error codes and descriptive messages.

Notes:​

  • Status Handling:
    • SUCCESS: Update was successful, and newValue reflects the updated value in the profile.
    • FAIL: Update failed, and newValue is the intended value but was not applied.
  • Error Details (when status is FAIL):
    • Error Code: A code identifying the type of error.
    • Description Message: A detailed explanation of the error.

It will be sent at least once.

Request​

Responses​

OK