Beats (Deprecated) - MX Documentation

Beats webhooks notify you when a beat is created, updated, generated, or deleted. Generated beats are created on demand and do not persist on the MX Platform. The payload for this webhook includes an action field that specifies the associated value of created, updated, generated, or deleted.

INFOThis webhook has been deprecated in favor of Insights.

Field	Data Type	Definition
`account_guids`	Array	An array of account GUIDs that are relevant to the information delivered in the beat.
`account_ids`	Array	An array of partner-defined identifiers for accounts that are relevant to the information delivered in the beat.
`active_at`	Integer	The date and time when the beat became active.
`created_at`	String	The date and time when the beat was created.
`description`	String	The human-readable information being delivered to the end user.
`digest`	String	A unique identifier derived from inputs to the beat to ensure beats are not duplicated.
`expires_at`	Integer	The date and time when the beat will expire.
`guid`	String	The unique identifier for the beat. Defined by MX.
`is_deleted`	Boolean	Whether the beat has been deleted.
`is_dismissed`	Boolean	Whether the beat has been dismissed.
`is_relevant`	Boolean	Whether the beat still contains information that is relevant, meaningful, or useable to the end user. For example, an overdraft warning will have `is_relevant` set to `false` if a large deposit is made into the associated account after the beat was created. Any beat that has already been displayed to or dismissed by the end user will be set to `false`. There are numerous examples and conditions.
`primary_account_guid`	String	The unique identifier for the account most relevant to the information delivered in the beat.
`primary_account_id`	String	The unique partner-defined identifier for the account most relevant to the information delivered in the beat.
`primary_transaction_guid`	String	The unique identifier for the transaction most relevant to the information delivered in the beat.
`primary_transaction_id`	String	The unique partner-defined identifier for the transaction most relevant to the information delivered in the beat.
`template`	String	A short label for the type of beat being delivered. For example, `SubscriptionPriceIncrease` or `MonthlyCategoryTotal`.
`title`	String	The title for the specific beat. For example, `Price Increase` or `Paycheck Deposit`.
`transaction_guids`	Array	An array of transaction GUIDs that are relevant to the information delivered in the beat.
`transaction_ids`	Array	An array of partner-defined transaction identifiers that are relevant to the information delivered in the beat.
`updated_at`	String	The date and time when the beat was last updated.
`user_guid`	String	The unique identifier for the user to which the beat belongs. Defined by MX.
`user_id`	String	The unique partner-defined identifier for the user to which the beat belongs.

Example Payload

JSON

{
  "action": "created",
  "beat": {
    "account_guids": [
      "ACT-2746bc4c-ee78-5631-5a33-062dea4b0437"
    ],
    "client_guid": "CLT-df09f6b4-aee9-4471-8d68-ac43adb00d65",
    "created_at": "1585680092",
    "deleted_at": null,
    "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.",
    "digest": "87+y8ZLvW/TIr5tbknUtGg==",
    "guid": "BET-725b097e-ab18-43ca-a7fe-3c98c5a1db08",
    "is_deleted": false,
    "is_dismissed": false,
    "is_relevant": true,
    "primary_account_guid": "ACT-2746bc4c-ee78-5631-5a33-062dea4b0437",
    "primary_transaction_guid": "TRN-3e5919b3-c9c9-4346-b187-2ff235d371ec",
    "template": "BillAmountNotStandard",
    "title": "Bill lower than usual",
    "transaction_guids": [
      "TRN-3e5919b3-c9c9-4346-b187-2ff235d371ec",
      "TRN-df09f6b4-aee9-4471-8d68-ac43adb00d65"
    ],
    "updated_at": null,
    "user_guid": "USR-29dfffe5-296e-4784-89fd-6e81c8e682e6",
    "user_id": "user-12345"
  }
}

Beats Templates

The following is a list of beat template names:

AmericanFederalBankHolidays
AmericanUpcomingDeadlineAlert
BillAmountNotStandard
CanadianFederalBankHolidays
CanadianUpcomingDeadlineAlert
CashBack
CategoryBudget
CategorySpending
CategorySpendingV2
CheckDeposit
CreditCardCloseToLimit
CreditUtilization
DebtPaymentReminderV2
DepositAggregate
DuplicatePayment
FeeDetected
GovernmentDeposit
IntroducePulse
LargeDeposit
LargeTransaction
LowAccountBalance
MerchantBudget
MerchantCreditReceived
MonthlyDebtToIncomeComparison
MonthlyDepositSummary
MonthlyNonEssentialCategorySummary
MonthlySavingsSummary
MonthlySpendComparison
MonthlySpendToIncomeComparison
MonthlySubscriptionAggregate
MonthlyTopMerchantSpending
MonthlyTopMerchantSpendingV2
NewMerchant
PayrollAdvance
PayrollDeposit
SavingsAccountBalancesSummary
SavingsOpportunity
SubscriptionDetected
SubscriptionPriceIncrease
TaxDeposit
UncategorizedTransactions
UpcomingBill
UpcomingSubscription
UserFeedback
WeekendSpendingSummary
WeeklyNewMerchants

​Beats Templates

Beats Templates