Guides

Models

Suggest Edits

You need to reach out to the fuse team to enable webhooks.

📘

For Teller and Mx, webhooks need to be enabled via your dashboard. Please reach out to the Fuse team to help you configure this.

Webhooks will be raised when there are updates for the user. The unified webhook model looks like this:

AttributesDescription
type
string 		Type of the webhook, ie "financial_connection.disconnected"
financial_connection_id
string		This is the id of the financial connection that this webhook is associated with. The financial connection id is returned with every exchange public token request
environment
string		Either "sandbox" or "production"
source
string		"plaid", "teller", "mx", "fuse"(for custom webhooks)
verification_token
string		Information needed to verify the authenticity of the webhook
remote_data
String		The original upstream webhook data for this unified model. For example, if this payload was unified from a "plaid" webhook, then that exact original plaid webhook would be stored here.

Examples

You can see the webhooks associated with each product (ie transactions) in the api reference.

Financial Connection Disconnected

This webhook indicates that the connection with the institution has been disconnected and needs to be reconnected. You can do this by passing in the access token in the create session endpoint.

{
  type: 'financial_connection.disconnected',
  financial_connection_id: "financial_connection_id",
  environment: "sandbox",
  source: "teller",
  remote_data: {}
}

Financial Connection Finished

This webhook indicates that the connection with the institution has finished. There is no way to reconnect and a new connection has to be established to the institution

{
  type: 'financial_connection.finished',
  financial_connection_id: "financial_connection_id",
  environment: "sandbox",
  source: "",
  remote_data: {}
}

Updated over 1 year ago