Webhook Schemas

#Webhook Payload

WebhookPayload

A Webhook Payload represents the object that the Quiltt system will deliver to your Subscription's targetUrl, and will include one of more Events.

environment:Environmentrequired
Information about the Environment.
eventTypes:array of stringsrequired
The types of events included in the Payload.
Enum:
connection.created connection.disconnected connection.synced.successful connection.synced.successful.initial connection.synced.successful.historical connection.synced.errored.repairable connection.synced.errored.service connection.synced.errored.provider connection.synced.errored.institution account.created account.verified account.reconnected balance.created statement.ready profile.created profile.ready profile.deleted
events:array of objectsrequired
The events included in this Payload.

#Events

ProfileEvent

A Profile Event represents a change pertaining to a Profile in your Quiltt Environment.

profile.created fires once a new Profile is created in your Environment.
profile.deleted fires when a Profile has been fully deleted from your Environment.
profile.ready fires when Enrichment has been completed. The metadata object may provide startDate, endDate and connectionId fields indicating the scope of data changed on the Profile.

id:string <global_id-v1>required
The ID of the Event.
Example: evt_12sDfIGkY96vVvNvTqNfn9
at:string <date-time>required
The timestamp of when the Event occurred, in ISO 8601 format.
type:stringrequired
The type of Profile Event that occurred.
One of:
profile.created profile.ready profile.deleted
Example: profile.ready
profile:objectrequired
The basic Profile information associated with the Event.
record:objectrequired
The Profile associated with the Event.
metadata:objectrequired
Additional context associated with the Event. Currently the following types expose context via metadata:
- connection.synced.successful*: may provide startDate and endDate indicating the date range of new data synced for the Connection.
- profile.ready: may provide startDate, endDate and a connectionId indicating the scope of data changed on the Profile.
- account.reconnected: will provide from and to containing objects for the old and new Connections respectively. The Connection objects will contain an id and provider.
Example:
{ "startDate": "2024-10-24", "endDate": "2025-01-24" }

ConnectionEvent

A Connection Event represents a change pertaining to a Connection on one of your Profiles.

connection.created fires onces a new Connection is created on a Profile. Note that it is highly recommended that you use the Connector onExitSuccess callback to track new Connections being created.
connection.synced.successful fires when a Connection is successfully synced with the provider. For most use-cases we recommend using the profile.ready event, which fires after Enrichment has been completed on the latest data.
connection.synced.successful.initial fires once after the first quick sync is completed on a Connection.
connection.synced.successful.historical fires when a deep historical sync is completed on a Connection.
connection.disconnected fires when a Connection has been been fully disconnected from the provider.
connection.synced.errored.repairable fires when a Connection becomes ERROR_REPAIRABLE and requires user action to resume syncing. Have the user complete the Connector Reconnect flow to resolve this error.
connection.synced.errored.service fires when an unexpected error occurs attempting to sync the Connection. Visit our Status page or contact Quiltt Support for more information.
connection.synced.errored.provider fires when the Connection provider is reporting an error with the Connection. Inspect the Connection's Remote Data for more information.
connection.synced.errored.institution fires when the provider is reporting an error with the connected Institution.

id:string <global_id-v1>required
The ID of the Event.
Example: evt_12sDfIGkY96vVvNvTqNfn9
at:string <date-time>required
The timestamp of when the Event occurred, in ISO 8601 format.
type:stringrequired
The type of Connection Event that occurred.
One of:
connection.created connection.disconnected connection.synced.successful connection.synced.successful.initial connection.synced.successful.historical connection.synced.errored.repairable connection.synced.errored.service connection.synced.errored.provider connection.synced.errored.institution
Example: connection.synced.successful
profile:objectrequired
The basic Profile information associated with the Event.
record:objectrequired
The Connection associated with the Event.
metadata:objectrequired
Additional context associated with the Event. Currently the following types expose context via metadata:
- connection.synced.successful*: may provide startDate and endDate indicating the date range of new data synced for the Connection.
- profile.ready: may provide startDate, endDate and a connectionId indicating the scope of data changed on the Profile.
- account.reconnected: will provide from and to containing objects for the old and new Connections respectively. The Connection objects will contain an id and provider.
Example:
{ "startDate": "2024-10-24", "endDate": "2025-01-24" }

AccountEvent

An Account Event represents a change pertaining to an Account for one of your Profiles

account.created fires when a new Account is registered on a Profile.
account.verified fires when an Account has been verified for money movement.
account.reconnected fires when an existing Account has been associated with a new Connection. This can occur when you reconnect to an Institution you had previously connected.

id:string <global_id-v1>required
The ID of the Event.
Example: evt_12sDfIGkY96vVvNvTqNfn9
at:string <date-time>required
The timestamp of when the Event occurred, in ISO 8601 format.
type:stringrequired
The type of Account Event that occurred.
One of:
account.created account.verified account.reconnected
Example: account.verified
profile:objectrequired
The basic Profile information associated with the Event.
record:objectrequired
The Account associated with the Event.
metadata:objectrequired
Additional context associated with the Event. Currently the following types expose context via metadata:
- connection.synced.successful*: may provide startDate and endDate indicating the date range of new data synced for the Connection.
- profile.ready: may provide startDate, endDate and a connectionId indicating the scope of data changed on the Profile.
- account.reconnected: will provide from and to containing objects for the old and new Connections respectively. The Connection objects will contain an id and provider.
Example:
{ "startDate": "2024-10-24", "endDate": "2025-01-24" }

BalanceEvent

A Balance Event represents a change pertaining to a Balance in your Quiltt Environment.

balance.created fires when a new Balance is created in your Environment.

id:string <global_id-v1>required
The ID of the Event.
Example: evt_12sDfIGkY96vVvNvTqNfn9
at:string <date-time>required
The timestamp of when the Event occurred, in ISO 8601 format.
type:stringrequired
The type of Balance Event that occurred.
One of:
balance.created
Example: balance.created
profile:objectrequired
The basic Profile information associated with the Event.
record:objectrequired
The Balance associated with the Event.
metadata:objectrequired
Additional context associated with the Event. Currently the following types expose context via metadata:
- connection.synced.successful*: may provide startDate and endDate indicating the date range of new data synced for the Connection.
- profile.ready: may provide startDate, endDate and a connectionId indicating the scope of data changed on the Profile.
- account.reconnected: will provide from and to containing objects for the old and new Connections respectively. The Connection objects will contain an id and provider.
Example:
{ "startDate": "2024-10-24", "endDate": "2025-01-24" }

StatementEvent

A Statement Event represents a change pertaining to a Statement in your Quiltt Environment.

statement.created fires once a new Statement has been saved.
statement.ready fires when a Statement has been enriched with date-related metadata.

id:string <global_id-v1>required
The ID of the Event.
Example: evt_12sDfIGkY96vVvNvTqNfn9
at:string <date-time>required
The timestamp of when the Event occurred, in ISO 8601 format.
type:stringrequired
The type of Statement Event that occurred.
One of:
statement.ready
Example: statement.ready
profile:objectrequired
The basic Profile information associated with the Event.
record:objectrequired
The Statement associated with the Event.
metadata:objectrequired
Additional context associated with the Event. Currently the following types expose context via metadata:
- connection.synced.successful*: may provide startDate and endDate indicating the date range of new data synced for the Connection.
- profile.ready: may provide startDate, endDate and a connectionId indicating the scope of data changed on the Profile.
- account.reconnected: will provide from and to containing objects for the old and new Connections respectively. The Connection objects will contain an id and provider.
Example:
{ "startDate": "2024-10-24", "endDate": "2025-01-24" }