Profile Update Event

A webhook event associated with the profile update process.

idstringrequired

Unique webhook event identifier.

Example: 07c3bcf5-1b6c-494e-9a29-776cfc54b4db

timestampdate-timerequired

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

customer objectrequired

idstringrequired

Possible values: <= 20 characters

Example: 500000334204

externalIdExternalId (string)

External identifier in merchant system. Must be passed during onboarding.

Possible values: non-empty and <= 40 characters

Example: a2322550-af91-417f-867e-681efad44b9d

titlestring

Personal title, Mr., Dr., etc.

Possible values: <= 15 characters

Example: Mr.

firstNamestringrequired

First name.

Possible values: <= 50 characters

Example: John

lastNamestringrequired

Last name.

Possible values: <= 50 characters

Example: Doe

changes object[]required

Array [

fieldstringrequired

JSON path of the field being updated.

Example: contactInfo.email

statusstringrequired

Status of the operation for the field.

Possible values: [SUCCESS, FAIL]

Example: FAIL

oldValuestringrequired

The previous value of the field.

Example: oldValue@mail.com

newValuestringrequired

The updated value of the field.

Example: new.value@mail.com

errorMessages object[]

List of error messages related to the update process.

Array [

codestring

Code identifying the type of error.

Example: VALIDATION_ERROR

messagestring

Human-readable description of the error.

Example: Email address duplication

]

]

Profile Update Event

{
  "id": "07c3bcf5-1b6c-494e-9a29-776cfc54b4db",
  "timestamp": "2021-07-15T17:54:12Z",
  "customer": {
    "id": "500000334204",
    "externalId": "a2322550-af91-417f-867e-681efad44b9d",
    "title": "Mr.",
    "firstName": "John",
    "lastName": "Doe"
  },
  "changes": [
    {
      "field": "contactInfo.email",
      "status": "FAIL",
      "oldValue": "oldValue@mail.com",
      "newValue": "new.value@mail.com",
      "errorMessages": [
        {
          "code": "VALIDATION_ERROR",
          "message": "Email address duplication"
        }
      ]
    }
  ]
}