API Reference

Webhooks

Fuse APIs use webhooks to asynchronously notify your APIs of important events during a user's lifetime.

Registering Webhooks

You can register new webhooks by visiting the settings for webhooks within Fuse Dashboard. For Sandbox, you can configure webhooks by visiting the same page within the Fuse Sandbox Dashboard.

When registering a webhook you will need to provide two things:

  1. A URL — this is what will be called when there is an event to send to you
  2. A list of events to subscribe to — choose which events you want us to tell you about

Available Events

  • analytics.started — a user's risk and affordability factors have started to be calculated
  • analytics.finished — a user's risk and affordability factors have finished being calculated
  • byod_accounts.started — a user's BYOD account data has started to be imported
  • byod_accounts.finished — a user's BYOD account data has finished being imported
  • byod_transactions.started — a user's BYOD transaction data has started to be imported
  • byod_transactions.finished — a user's BYOD transaction data has finished being imported
  • open_banking_sync.started — a user's open banking data has started being synced
  • open_banking_sync.finished — a user's open banking data has finished being synced
  • user.deleted — a user has been deleted

When using our standard Opening Banking Flow events are fired in the following order:

  1. open_banking_sync.started
  2. open_banking_sync.finished
  3. analytics.started
  4. analytics.finished

When using a BYOD flow events are fired in the following order:

  1. byod_accounts.started
  2. byod_accounts.finished
  3. byod_transactions.started
  4. byod_transactions.finished
  5. analytics.started
  6. analytics.finished

Handling Events

Fuse uses Svix to provide webhook services. See the Svix documentation on how to build and handle webhooks correctly.

Svix helpfully provides a number of libraries for handling webhooks in different languages which can be really helpful to get started.

🚧

Important

Make sure to verify your webhooks are coming from Fuse — attackers can impersonate services by simply sending a fake webhook to an endpoint, which could have dangerous consequences for lending decisions made on the basis of events received.

The Svix libraries provide verification functionality as standard.

Webhook Payloads

You can find documentation on what each webhook event will have in the payload by going to the settings page for webhooks in the Fuse Dashboard and clicking the "Event Catalog" tab. For Sandbox, visit the same page and tab within the Fuse Sandbox Dashboard.

On this tab you will find detailed documentation describing the JSON payload for each event, along with example payloads that you can use for testing.