Skip to main content

Users

User webhooks notify you when a user is created, updated, or deleted in the MX system.

FieldData TypeDefinition
birthdayStringThe birthdate of user, represented in ISO 8601 format.
credit_scoreIntegerThe credit score of the user.
emailStringThe email address of the user.
email_is_verifiedBooleanThis indicates whether the email has been verified.
first_nameStringThe first name of the user.
genderIntegerThe gender of the user. Returns 0 for male and 1 for female.
guidStringThe unique identifier for the user. Defined by MX.
idStringThe unique partner-defined identifier for the user.
is_disabledBooleanThis indicates whether the user has been disabled.
last_nameStringThe last name of the user.
logged_in_atIntegerThe date and time the user last logged in. Represented as a Unix Epoch datetime.
metadataStringAdditional information a partner can store on the user.
phoneStringThe phone number of the user.
phone_is_verifiedBooleanThis indicates whether the phone number has been verified.
postal_codeStringThe postal code of the user.
revisionIntegerThe revision number for the user.

Example Payload


_29
POST /admin/webhooks
_29
HTTP/1.1
_29
content-type: application/json; charset=utf-8
_29
accept: application/json
_29
User-Agent: HTTPClient/1.0 (2.7.1, ruby 2.2.2
_29
(2015-09-02)) Date: Thu, 14 Apr 2018 04:26:04 GMT Content-Length: 231
_29
Host: abc.com
_29
_29
{
_29
"action": "created",
_29
"user": {
_29
"birthday": "1980-01-01",
_29
"credit_score": 700,
_29
"email": "bennythejet@gmail.com",
_29
"email_is_verified": true,
_29
"first_name": "Benjamin",
_29
"gender": 0,
_29
"guid": "USR-f81df24f-a54e-6afd-0ee9-71a9f6f20e26",
_29
"id": "U-1234567",
_29
"is_disabled": false,
_29
"last_name": "Rodriguez",
_29
"logged_in_at": 1524694004,
_29
"metadata": "Additional information",
_29
"phone": "19012225555",
_29
"phone_is_verified": false,
_29
"postal_code": "90210",
_29
"revision": 10
_29
}
_29
}