Loading...
Search the Quiltt documentation
Loading...
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:EnvironmentrequiredInformation about the Environment.
eventTypes:array of stringsrequiredThe types of events included in the Payload.
connection.created connection.synced.successful connection.synced.successful.initial connection.synced.successful.historical connection.synced.errored.repairable connection.synced.errored.institution connection.synced.errored.provider connection.synced.errored.service connection.disconnected account.created account.owners_verified account.reconnected account.verified balance.created statement.ready profile.created profile.ready profile.deleted events:array of objectsrequiredThe events included in this Payload.
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.ready: Fires when data associated with the Profile has changed.profile.deleted: Fires when a Profile has been fully deleted from your Environment.id:string<global_id-v1>requiredThe ID of the Profile Event.
at:string<date-time>requiredThe UTC date and time when the Profile Event occurred, in ISO 8601 format.
type:stringrequiredThe type of Profile Event that occurred.
profile.created profile.ready profile.deleted profile:objectrequiredThe basic Profile information associated with the Profile Event.
record:objectrequiredThe Profile associated with the Profile Event.
metadata:objectrequiredAdditional context associated with the Profile Event. Currently the following Profile events expose context via metadata:
profile.ready: may include an optional connectionId and/or an optional startDate/endDate pair, indicating the scope of data changed.{
"startDate": "2024-10-24",
"endDate": "2025-01-24",
"connectionId": "conn_14TJiFDKRJlPiBHuukUIlXZ"
}A Connection Event represents a change pertaining to a Connection on one of your Profiles.
It is highly recommended that you use the Connector onExitSuccess callback to track new Connections being created. For help troubleshooting errored syncs, see the Connection docs, the Connector Reconnect flow, and the Status page.
connection.created: Fires once a new Connection is created on a Profile.connection.synced.successful: Fires when a Connection is successfully synced with the provider.connection.synced.successful.initial: Fires once after the first quick sync is completed on a Connection.connection.synced.successful.historical: Fires after historical data is synced following a successful Connector session, including both initial Connect and Reconnect flows.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.institution: Fires when the provider is reporting an error with the connected Institution.connection.synced.errored.provider: Fires when the provider is reporting an error with the Connection. Inspect the Connection's Remote Data for more information.connection.synced.errored.service: Fires when an unexpected error occurs attempting to sync the Connection.connection.disconnected: Fires when a Connection has been fully disconnected from the provider.id:string<global_id-v1>requiredThe ID of the Connection Event.
at:string<date-time>requiredThe UTC date and time when the Connection Event occurred, in ISO 8601 format.
type:stringrequiredThe type of Connection Event that occurred.
connection.created connection.synced.successful connection.synced.successful.initial connection.synced.successful.historical connection.synced.errored.repairable connection.synced.errored.institution connection.synced.errored.provider connection.synced.errored.service connection.disconnected profile:objectrequiredThe basic Profile information associated with the Connection Event.
record:objectrequiredThe Connection associated with the Connection Event.
metadata:objectrequiredAdditional context associated with the Connection Event. Currently the following Connection events expose context via metadata:
connection.synced.successful*: may include an optional startDate/endDate pair indicating the date range of new data synced for the Connection.{
"startDate": "2024-10-24",
"endDate": "2025-01-24"
}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.owners_verified: Fires when an Account's owners have been identified and become available in GraphQL.account.reconnected: Fires when an existing Account has been associated with a new Connection, such as when reconnecting to a previously connected Institution.account.verified: Fires when an Account becomes verified for money movement and ACH Numbers become available via the REST API.id:string<global_id-v1>requiredThe ID of the Account Event.
at:string<date-time>requiredThe UTC date and time when the Account Event occurred, in ISO 8601 format.
type:stringrequiredThe type of Account Event that occurred.
account.created account.owners_verified account.reconnected account.verified profile:objectrequiredThe basic Profile information associated with the Account Event.
record:objectrequiredThe Account associated with the Account Event.
metadata:objectrequiredAdditional context associated with the Account Event. Currently the following Account events expose context via metadata:
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.{
"from": {
"id": "conn_14TJiFDKRJlPiBHuukUIlXZ",
"provider": "MX"
},
"to": {
"id": "conn_15ABcDEFGhIjKlMnOpQrSt",
"provider": "FINICITY"
}
}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>requiredThe ID of the Balance Event.
at:string<date-time>requiredThe UTC date and time when the Balance Event occurred, in ISO 8601 format.
type:stringrequiredThe type of Balance Event that occurred.
balance.created profile:objectrequiredThe basic Profile information associated with the Balance Event.
record:objectrequiredThe Balance associated with the Balance Event.
metadata:objectrequiredCurrently there is no metadata available for Balance Events.
A Statement Event represents a change pertaining to a Statement in your Quiltt Environment.
statement.ready: Fires when a Statement has been enriched with date-related information.id:string<global_id-v1>requiredThe ID of the Statement Event.
at:string<date-time>requiredThe UTC date and time when the Statement Event occurred, in ISO 8601 format.
type:stringrequiredThe type of Statement Event that occurred.
statement.ready profile:objectrequiredThe basic Profile information associated with the Statement Event.
record:objectrequiredThe Statement associated with the Statement Event.
metadata:objectrequiredCurrently there is no metadata available for Statement Events.