Quiltt Logo

Webhook Schemas

Link to this section#Webhook Payload

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:objectrequired
    Information about the Environment.
  • eventTypes:array of stringsrequired
    The types of events included in the Payload. Enum:
    connection.created connection.updated connection.disconnected connection.synced.successful connection.synced.successful.historical connection.synced.errored.repairable connection.synced.errored.service connection.synced.errored.provider connection.synced.errored.institution account.created account.updated account.verified account.reconnected balance.created profile.created profile.updated profile.deleted
  • events:array of objectsrequired
    The events included in this Payload.

Link to this section#Events

Link to this section#Profile Event

A Profile Event represents a change pertaining to a Profile in your Quiltt Environment.
  • id:string<global_id-v1>required
    The ID of the Event.
    Example: evt_12sDfIGkY96vVvNvTqNfn9
  • type:stringrequired
    The type of Profile Event that occurred. One of:
    profile.created profile.updated profile.deleted
  • profile:objectrequired
    The basic Profile information associated with the Event.
  • record:objectrequired
    The Profile associated with the Event.

Link to this section#Connection Event

A Connection Event represents a change pertaining to a Connection in your Quiltt Environment.
  • id:string<global_id-v1>required
    The ID of the Event.
    Example: evt_12sDfIGkY96vVvNvTqNfn9
  • type:stringrequired
    The type of Connection Event that occurred. One of:
    connection.created connection.updated connection.disconnected connection.synced.successful connection.synced.successful.historical connection.synced.errored.repairable connection.synced.errored.service connection.synced.errored.provider connection.synced.errored.institution
  • profile:objectrequired
    The basic Profile information associated with the Event.
  • record:objectrequired
    The Connection associated with the Event.

Link to this section#Account Event

An Account Event represents a change pertaining to an Account in your Quiltt Environment.
  • id:string<global_id-v1>required
    The ID of the Event.
    Example: evt_12sDfIGkY96vVvNvTqNfn9
  • type:stringrequired
    The type of Account Event that occurred. One of:
    account.created account.updated account.verified account.reconnected
  • profile:objectrequired
    The basic Profile information associated with the Event.
  • record:objectrequired
    The Account associated with the Event.

Link to this section#Balance Event

A Balance Event represents a change pertaining to a Balance in your Quiltt Environment.
  • id:string<global_id-v1>required
    The ID of the Event.
    Example: evt_12sDfIGkY96vVvNvTqNfn9
  • type:stringrequired
    The type of Balance Event that occurred. One of:
    balance.created
  • profile:objectrequired
    The basic Profile information associated with the Event.
  • record:objectrequired
    The Balance associated with the Event.
Integrations →