Bridge API Documentation

Bridge Documentation

Welcome to our API documentation!

We're happy to share with you our new API 2021 version! Please check our Product Changelog to know the main changes.

You'll find comprehensive guides and documentation to help you start working with Bridge as quickly as possible, as well as support if you get stuck.

Let's jump right in!

Get Started

Receive event notifications with webhooks

Listen for events on your users accounts and automatically trigger reactions

Introduction

We use webhooks to notify your applications when specific events happen. For now the events available are AIS-related (if you use items and transactions for example). PIS-related events will come later.

Create a webhook from the dashboard

You can create webhooks from your dashboard. We will ask you to define:

  • your callback URL for this webhook
  • an optional name
  • the events you want to receive

You can create up to 10 webhooks per application.

To secure your webhooks, we recommend you to use the secret we provide when you create them. Please see the dedicated section to get the security best practices.

Note: only Admins can manage webhooks

Test your webhook with our test event

After creating a webhook, you can test it directly from your dashboard by clicking the "Send a test" button. We will send a fake event to your webhook, always with the same response:

{
  "content": {
    "item_id": 1234567890,
    "status": 0,
    "user_uuid": "9a95b38f-f98b-417a-988b-9d0d584893e7"
  },
  "timestamp": 1611681789,
  "type": "TEST_EVENT"
}

Events

Different events can be triggered:

  • an item has been created
  • an item has been refreshed
  • an account has been created
  • an account has been updated

Please find the full list and details here.

Retry rules

When we call your webhook, we expect you to return a 200 response. Send a successful 200 response as quickly as possible because we retry the event if a response is not sent within a reasonable time. Write any long-running processes as code that can run asynchronously outside the webhook endpoint.

If we encounter an error with a message sent to your webhook (ie. http code different than 2xx or a late response), we will try to resend the message for 1 to 2 days with an exponential back off.

Updated 6 months ago


Receive event notifications with webhooks


Listen for events on your users accounts and automatically trigger reactions

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.