Skip to main content

Beats Deprecated

The beat webhook notifies you when a beat is created, updated, generated, or deleted. Generated beats are created on-demand and are not persisted on the MX Platform.

info

This webhook has been deprecated. MX has rebranded "Pulse" to "MXinsights" and "beats" to "insights"; we are currently working to produce new endpoints that incorporate a new "insights" spec as well as other improvements. As such, all Pulse/beats endpoints have been deprecated.

We will continue for a limited period of time to support these deprecated endpoints for existing integrations, but new integrations should not build to these endpoints and instead should plan to code up to the new endpoints. MX anticipates their release in early to mid 2022.

FieldData TypeDefinition
account_guidsArrayAn array of account GUIDs that are relevant to the information delivered in the beat.
account_idsArrayAn array of partner-defined identifiers for accounts that are relevant to the information delivered in the beat.
active_atIntegerThe date and time at which the beat became active.
created_atStringThe date and time at which the beat was created.
descriptionStringThe human-readable information being delivered to the end user.
digestStringA unique identifier derived from inputs to the beat which ensures beats are not duplicated.
expires_atIntegerThe date and time at which the beat will expire.
guidStringThe unique identifier for the beat. Defined by MX.
is_deletedBooleanThis indicates whether the beat has been deleted.
is_dismissedBooleanThis indicates whether the beat has been dismissed.
is_relevantBooleanThis indicates whether a beat still contains information that is relevant, meaningful, or useable to the end user. For example, an OverdraftWarning will have is_relevant set to false if a large deposit is made into the associated account after the beat was created. Any beat which has already been displayed to or dismissed by the end user will be set to false. There are numerous examples and conditions.
primary_account_guidStringThe unique identifier for the account most relevant to the information delivered in the beat.
primary_account_idStringThe unique partner-defined identifier for the account most relevant to the information delivered in the beat.
primary_transaction_guidStringThe unique identifier for the transaction most relevant to the information delivered in the beat.
primary_transaction_idStringThe unique partner-defined identifier for the transaction most relevant to the information delivered in the beat.
templateStringA short label for the type of beat being delivered, e.g., SubscriptionPriceIncrease or MonthlyCategoryTotal.
titleStringThe title for the specific beat, e.g., Price Increase or Paycheck Deposit.
transaction_guidsArrayAn array of transaction GUIDs that are relevant to the information delivered in the beat.
transaction_idsArrayAn array of partner-defined transaction identifiers that are relevant to the information delivered in the beat.
updated_atStringThe date and time at which the beat was last updated.
user_guidStringThe unique identifier for the user to which the beat belongs. Defined by MX.
user_idStringThe unique partner-defined identifier for the user to which the beat belongs.

Example Payload


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

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
On this page