Insights Webhook

Insight webhooks notify when an insight is created, updated, or deleted.

Insight Webhook Fields

Field Name	Data Type	Definition
active_at	Integer	The date and time the insight is active, given in Unix epoch time.
client_guid	String	The unique identifier for the client associated with the insight. Defined by MX.
created_at	Integer	The date and time 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	This indicates whether there are accounts associated with the insight.
has_associated_categories	Boolean	This indicates whether there are categories associated with the insight.
has_associated_merchants	Boolean	This indicates whether there are merchants associated with the insight.
has_associated_scheduled_payments	Boolean	This indicates whether there are scheduled payments associated with the insight.
has_associated_transactions	Boolean	This indicates whether there are transactions associated with the insight.
has_been_displayed	Boolean	This indicates whether the insight has been shown to the end user.
is_dismissed	Boolean	This indicates 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 the insight was last updated, given in ISO 8601 without a timestamp.
user_guid	String	The unique identifier for the user to which the insight belongs. Defined by MX.
user_id	String	The unique partner-defined identifier for the user associated with the insight.

Example Payload

Example

Language:json

_24

{

_24

"action": "created",

_24

"insight": {

_24

"active_at": "1665576000",

_24

"client_guid": "CLT-0858efd1-2d2e-6a5d-f2b5-c7dad42ef184",

_24

"created_at": "1665602439",

_24

"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.",

_24

"guid": "BET-725b097e-ab18-43ca-a7fe-3c98c5a1db08",

_24

"has_associated_accounts": true,

_24

"has_associated_categories": true,

_24

"has_associated_merchants": false,

_24

"has_associated_scheduled_payments": false,

_24

"has_associated_transactions": true,

_24

"has_been_displayed": false,

_24

"is_dismissed": false,

_24

"micro_description": null,

_24

"micro_title": null,

_24

"template": "BillAmountNotStandard",

_24

"title": "Bill lower than usual",

_24

"updated_at": "2020-03-31T18:41:32+00:00",

_24

"user_guid": "USR-29dfffe5-296e-4784-89fd-6e81c8e682e6",

_24

"user_id": "usr-1234-abcd"

_24

}

_24

}