Event Message

The table below describes the structure of the event.

Field	Description
`customer_id`	The customer identifier that this event relates to
`completed_at`	An RFC3339 timestamp of the generation time
`corrections`	Object containing all the transactions that have been completed as part of a single request
`transaction_id`	Id of the transaction that has been corrected
`from`	Category that the transaction has changed from
`to`	Category that the transaction has changed to
`attribute`	Identifies at what level the correction happened `category_l1` or `category_l2`

Examples

{
  "customer_id": "test-customer-id",
  "completed_at": "2024-07-23T08:36:31.103079Z",
  "corrections": [
    {
      "transaction_id": "test-transaction-id-1",
      "from": "utilities",
      "to": "shopping",
      "attribute": "category_l1"
    }
  ]
}

{
  "customer_id": "test-customer-id",
  "completed_at": "2024-07-23T08:36:31.103079Z",
  "corrections": [
    {
      "transaction_id": "test-transaction-id-1",
      "from": "utilities",
      "to": "shopping",
      "attribute": "category_l1"
    },
		{
      "transaction_id": "test-transaction-id-2",
      "from": "utilities",
      "to": "shopping",
      "attribute": "category_l1"
    },
		{
      "transaction_id": "test-transaction-id-3",
      "from": "utilities",
      "to": "shopping",
      "attribute": "category_l1"
    }
  ]
}

How And When Is This Event Triggered

This webhook triggers each time a transaction has had the category corrected, such as; when a transaction is corrected as part of a successful call to corrections/v2/categories or when future transactions are ingested that are similar to existing transactions that have been corrected and when the include_similar flag has been set to true.

More information about category corrections can be found in this guide.

You can subscribe to this webhook within Bud's developer console.