Users - MX Documentation

User webhooks notify you when a user is created, updated, or deleted in the MX system. The payload for this webhook includes an action field that specifies the associated value of created, updated, or deleted.

Field	Data Type	Definition
`birthday`	String	The birthdate of user. Given in ISO 8601 format.
`credit_score`	Integer	The credit score of the user.
`email`	String	The email address of the user.
`email_is_verified`	Boolean	Whether the email address has been verified.
`first_name`	String	The first name of the user.
`gender`	Integer	The gender of the user. Returns `0` for male and `1` for female.
`guid`	String	The unique identifier for the user. Defined by MX.
`id`	String	The unique partner-defined identifier for the user.
`is_disabled`	Boolean	Whether the user has been disabled.
`last_name`	String	The last name of the user.
`logged_in_at`	Integer	The date and time when the user last logged in. Given in Unix time.
`metadata`	String	Additional information a partner can store on the user.
`phone`	String	The phone number of the user.
`phone_is_verified`	Boolean	Whether the phone number has been verified.
`postal_code`	String	The postal code of the user.
`revision`	Integer	The revision number for the user.

Example Payload

JSON

POST /admin/webhooks
HTTP/1.1
content-type: application/json; charset=utf-8
accept: application/json
User-Agent: HTTPClient/1.0 (2.7.1, ruby 2.2.2
(2015-09-02)) Date: Thu, 14 Apr 2018 04:26:04 GMT Content-Length: 231
Host: abc.com

{
  "action": "created",
  "user": {
    "birthday": "1980-01-01",
    "credit_score": 700,
    "email": "bennythejet@gmail.com",
    "email_is_verified": true,
    "first_name": "Benjamin",
    "gender": 0,
    "guid": "USR-f81df24f-a54e-6afd-0ee9-71a9f6f20e26",
    "id": "U-1234567",
    "is_disabled": false,
    "last_name": "Rodriguez",
    "logged_in_at": 1524694004,
    "metadata": "Additional information",
    "phone": "19012225555",
    "phone_is_verified": false,
    "postal_code": "90210",
    "revision": 10
  }
}