Tags and Taggings - MX Documentation

Tags

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

Field	Data Type	Definition
`guid`	String	The unique identifier for the tag. Defined by MX.
`revision`	Integer	The revision number of this tag record.
`name`	String	The name of the tag set by the user.
`updated_at`	Integer	The date and time when this tag was last updated.
`user_guid`	String	The unique identifier for the user the tag is attached to. Defined by MX.
`user_id`	String	The unique partner-defined identifier 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 2016 04:26:04 GMT Content-Length: 231
Host: abc.com

{
  "action": "created",
  "tag": {
    "guid": "TAG-03ffc670-2a6d-4c1d-9172-8413fd18a2ec",
    "revision": 1,
    "name": "Tax Receipts",
    "updated_at": 1490737101,
    "user_guid": "USR-29beed70-9a48-5c1d-9172-7413eb68a3ef",
    "user_id": "U-1234567"
  }
}

Taggings

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

Field	Data Type	Definition
`guid`	String	The unique identifier for the tagging. Defined by MX.
`member_is_managed_by_user`	Boolean	Whether the member associated with the user is managed by the user.
`revision`	Integer	The revision number of this tagging record.
`transaction_id`	String	The unique identifier for the transaction the tag belongs to. Defined by the data provider.
`transaction_guid`	String	The unique identifier for the transaction the tag belongs to. Defined by MX.
`tag_guid`	String	The unique identifier for the tag. Defined by MX.
`tag_name`	String	The name of the tag set by the user.
`updated_at`	Integer	The date and time when this tagging was last updated.
`user_guid`	String	The unique identifier for the user the tagging is attached to. Defined by MX.
`user_id`	String	The unique partner-defined identifier 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 2016 04:26:04 GMT Content-Length: 231
Host: abc.com
{
  "action": "created",
  "tagging": {
    "guid": "TGN-03ffc670-2a6d-4c1d-9172-8413fd18a2ec",
    "member_is_managed_by_user": true,
    "revision": 1,
    "transaction_id": "T-1234567",
    "transaction_guid": "TRN-72b36023-d25d-7f1e-8013-654bf0d3de44",
    "tag_guid": "TAG-001",
    "tag_name": "Tax Receipts",
    "updated_at": 1490737101,
    "user_guid": "USR-29beed70-9a48-5c1d-9172-7413eb68a3ef",
    "user_id": "U-1234567"
  }
}

​Tags

​Taggings

Tags

Taggings