Discover Spending Analysis (discoverSpendingAnalysisNewConnections)

Sent when a new user adds their first connection and has recent transactions to analyse.

Id: discoverSpendingAnalysisNewConnections

A webhook event that notifies when a new user (profile created within the last 30 days) adds their first bank connection and has recent transaction data available for spending analysis. This webhook helps identify users who are good candidates for spending insights and analysis features.

When it is sent

  • User profile is less than 30 days old
  • User has recent transactions (from the last 3 months) in their connected accounts
  • Connection includes valid account data
  • External connection ID is present

Payload

These fields are sent in the payload object of the webhook envelope.

NameTypeDescription
categorystringAlways spending, to indicate this relates to spending analysis
connectionIdstringThe ID of the newly added connection

Example (JSON format)

{
  "id": "abe168ce-1b2f-4c38-9c92-db5730485cb3",
  "eventType": "discoverSpendingAnalysisNewConnections",
  "userId": "5c79210bbac25ecb5e71ac40",
  "payload": {
    "category": "spending",
    "connectionId": "1ffe704d39629a929c8e293880fb449a:cb126400-1d69-4242-b188-fc8b5c22783b"
  }
}

This example uses the JSON format. JWT webhooks carry the same payload fields in a different envelope, and batched webhooks list events without payloads. See Webhook Format.