Categories - MX Documentation

The payload for this webhook includes an action field that specifies the associated value of created, updated, or deleted.

Field	Data Type	Definition
`created_at`	Integer	The date and time when the category was created.
`guid`	String	The unique identifier for the category. Defined by MX.
`is_default`	Boolean	Whether the category is a default category.
`is_income`	Boolean	Whether the category represents income.
`metadata`	String	Additional information a partner can store on the category.
`name`	String	The name of the category that is visible to the user.
`parent_guid`	String	The parent GUID of the category.
`revision`	Integer	The revision number for the category.
`updated_at`	Integer	The date and time when the category was updated.
`user_guid`	String	The unique identifier for the user the category is attached to. Defined by MX.
`user_id`	String	The unique partner-defined identifier for the user.

Example Payload

JSON

POST https://abc.com/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 2016 04:26:04 GMT Content-Length: 231
Host: abc.com
{
  "action": "updated",
  "category": {
    "created_at": 1234567890,
    "guid": "CAT-123",
    "is_default": false,
    "is_income": true,
    "metadata": "metadata~set~by~partner",
    "name": "Coffee",
    "parent_guid": "CAT-bd56d35a-a9a7-6e10-66c1-5b9cc1b6c81a",
    "revision": 13,
    "updated_at": 123456890,
    "user_guid": "USR-dfb1b536-692d-f172-88c6-643a2691b30c",
    "user_id": "0128372140"
  }
}