2025-01-10: Changes to the bankFeeds.sourceAccount webhook payload
On January 10, 2025, we will update the webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. payloads for the bankFeeds.sourceAccount.connected and bankFeeds.sourceAccount.disconnected event types to align with our new webhook schema definition.
When these webhooksWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. were initially released, they didn't include the top-level schema which provides metadata about the event. The payload now also includes reference companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. details.
1 | { | 1 | { | ||
2 | - | 2 | + | "eventType": "bankFeeds.sourceAccount.connected", | |
3 | - | "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", | 3 | + | "generatedDate": "2022-10-23T00:00:00.000Z", |
4 | - | "connectionId": "2e9d2c44-f675-40ba-8049-353bfcb5e171", | 4 | + | "payload": { |
5 | - | "bankAccount": { | 5 | + | "referenceCompany": { |
6 | - | "id": "acc-002", | 6 | + | "id": "8a210b68-6988-11ed-a1eb-0242ac120002" |
7 | - | "accountName": "account-081", | 7 | + | }, |
8 | - | "sortCode": "123456", | 8 | + | "connectionId": "2e9d2c44-f675-40ba-8049-353bfcb5e171", |
9 | - | "accountType": "Credit", | 9 | + | "sourceAccount": { |
10 | - | "accountNumber": "12345670", | 10 | + | "id": "acc-002", |
11 | - | "currency": "GBP", | 11 | + | "accountName": "account-081", |
12 | - | "balance": 99.99, | 12 | + | "sortCode": "123456", |
13 | - | "modifiedDate": "2023-01-09T14:14:14.1057478Z", | 13 | + | "accountType": "Credit", |
14 | - | "status": "pending" | 14 | + | "accountNumber": "12345670", |
15 | - | } | 15 | + | "currency": "GBP", |
16 | - | 16 | + | "balance": 99.99, | |
17 | + | "modifiedDate": "2023-01-09T14:14:14.1057478Z", | |||
18 | + | "status": "pending" | |||
19 | + | } | |||
20 | + | } | |||
17 | } | 21 | } |
Action required
If you are currently using bankFeeds.sourceAccount.connected and bankFeeds.sourceAccount.disconnected webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. event types, you will need to update your webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. consumer that listens to these event types to handle the updated schema definition.
Expected impact
If no action is taken to handle the updated schema definition by January 10, 2025, receiving the bankFeeds.sourceAccount.connected and bankFeeds.sourceAccount.disconnected event types to your webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. consumer will result in deserialization errors. This means your application will not process these events correctly.