Insights - MX Documentation

Insights webhooks notify you when an insight 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 Name	Data Type	Definition
`active_at`	Integer	The date and time when the insight became active. Given in Unix epoch time.
`client_guid`	String	The unique identifier for the client. Defined by MX.
`created_at`	Integer	The date and time when the insight was created. Given in Unix epoch time.
`description`	String	The human-readable information being delivered to the end user.
`guid`	String	The unique identifier for the insight. Defined by MX.
`has_associated_accounts`	Boolean	Whether there are accounts associated with the insight.
`has_associated_categories`	Boolean	Whether there are categories associated with the insight.
`has_associated_merchants`	Boolean	Whether there are merchants associated with the insight.
`has_associated_scheduled_payments`	Boolean	Whether there are scheduled payments associated with the insight.
`has_associated_transactions`	Boolean	Whether there are transactions associated with the insight.
`has_been_displayed`	Boolean	Whether the insight has been shown to the end user.
`is_dismissed`	Boolean	Whether the insight has been dismissed by the end user.
`micro_description`	String	The insight’s description that displays to the end user in the Micro Widget.
`micro_title`	String	The insight’s title that displays to the end user in the Micro Widget. For example, `Price Increase` or `Paycheck Deposit`.
`template`	String	A short label for the type of insight being delivered. For example, `SubscriptionPriceIncrease` or `MonthlyCategoryTotal`.
`title`	String	The title for the specific insight. For example, `Price Increase` or `Paycheck Deposit`.
`updated_at`	String	The date and time when the insight was last updated. Given in ISO 8601 format.
`user_guid`	String	The unique identifier for the user. Defined by MX.
`user_id`	String	The unique partner-defined identifier for the user.

Example Payload

{
  "action": "created",
  "insight": {
    "active_at": "1665576000",
    "client_guid": "CLT-0858efd1-2d2e-6a5d-f2b5-c7dad42ef184",
    "created_at": "1665602439",
    "description": "It looks like your most recent bill from Comcast was lower than it normally is. You paid $31.26, which is 28% lower than your recent average payment of $43.43.",
    "guid": "BET-725b097e-ab18-43ca-a7fe-3c98c5a1db08",
    "has_associated_accounts": true,
    "has_associated_categories": true,
    "has_associated_merchants": false,
    "has_associated_scheduled_payments": false,
    "has_associated_transactions": true,
    "has_been_displayed": false,
    "is_dismissed": false,
    "micro_description": null,
    "micro_title": null,
    "template": "BillAmountNotStandard",
    "title": "Bill lower than usual",
    "updated_at": "2020-03-31T18:41:32+00:00",
    "user_guid": "USR-29dfffe5-296e-4784-89fd-6e81c8e682e6",
    "user_id": "usr-1234-abcd"
    }
}   

​Example Payload

Example Payload