Insights Balances Triggered

insights.balances.triggered

This webhook triggers when an actionable insight triggers with respect to a customer's balances.

Event Message

The table below describes the structure of the event.

FieldDescriptionValues
customer_idThe customer identifier that this event relates to
created_atAn RFC3339 timestamp of the generation time
linkThe origin endpoint of the Insight
insightThe insight details
insight.instance_idThe unique identifier for this instance of the insight
insight.insight_typeThe insight typecannot_cover_bills
insight.detailsA URL pointing to the of the details endpoint for this specific insight instance

Examples

{
  "customer_id": "82a90a04-4bdf-446a-932e-fb559ea99c29",
  "created_at": "2023-10-02T14:05:55Z",
  "link": "https://api-sandbox.thisisbud.com/insights/v1/actionable/balances",
  "insight": {
    "instance_id": "d6753a05-ea45-48ba-a580-cae94825195d",
    "insight_type": "cannot_cover_bills",
    "details": "https://api-sandbox.thisisbud.com/insights/v1/actionable/balances/cannot_cover_bills/cannot_cover_bills_8789764a-df2f-4589-b550-00bcd0e9cb2c/details"
  }
}

How And When Is This Event Triggered

Legend

IconDescription
This can be a customer initiated refresh either by, an Initiate Refresh request or by ingesting new accounts/transactions via the first party ingestion endpoints. Alternatively as part of a background refresh if hosted refreshes are enabled.
Specifically refreshes, connecting a new customer will not generate webhooks
A short delay to ensure all enrichments have been completed.