Webhooks

Webhooks trigger these events:

an item has been created
an item has been refreshed
an account has been created
an account has been updated
an account has been deleted
a transfer account has been created
a transfer account has been updated
a transfer has been created
a transfer has been updated

Please refer to the Webhooks section to configure them.

Item created

This event is triggered at the very beginning of an item creation, when users enter their credentials in Bridge Connect and then click on "Add your account". You can use it, for example, to know if a user left the Bridge Connect before the end of the synchronization.

Example:

{
  "content": {
    "item_id": 4568477,
    "user_uuid": "766b2f5d-a942-492c-9ea7-2e5aa88cb672"
  },
  "timestamp": 1612782588323,
  "type": "item.created"
}

Account created

This event is triggered when we detect a new account on an item. It can be triggered at the same time as Item created but also later, for example if users opened a new account with their bank.

{
  "content": {
    "account_id": 22908770,
    "balance": 1678.12,
    "item_id": 4568477,
    "user_uuid": "766b2f5d-a942-492c-9ea7-2e5aa88cb672"
  },
  "timestamp": 1612782588323,
  "type": "item.account.created"
}

Account updated

This event is triggered each time we detect an update on an account. An update can be:

transactions have been added
transactions have been deleted
transactions have been updated
balance has changed

Example:

{
  "content": {
    "account_id": 22908770,
    "balance": 1678.12,
    "item_id": 4568477,
    "nb_deleted_transactions": 0,
    "nb_new_transactions": 15,
    "nb_updated_transactions": 0,
    "user_uuid": "766b2f5d-a942-492c-9ea7-2e5aa88cb672"
  },
  "timestamp": 1612782588323,
  "type": "item.account.updated"
}

Account deleted

This event is triggered when a bank account isn't updated by the bank anymore. In rare cases, if the bank account is updated again by the bank, you will receive item.account.updated events.

Example:

{
	"content": {
	"user_uuid": "4568f180-03ea-4915-af47-f266f06b6949",
	"item_id": 8390176,
	"account_id": 38439071
	},
	"timestamp": 1694506737325,
	"type": "item.account.deleted"
}

Item refreshed

Each time an item is refreshed, this event is triggered. You can use it to check if an item's status has changed, or to know right after a refresh that an item is now in error. The field full_refresh indicates you if we fetched the item's full history or not.

Example:

{
  "content": {
    "full_refresh": false,
    "item_id": 4568565,
    "status_code": 0,
    "status_code_info": "OK",
    "user_uuid": "766b2f5d-a942-492c-9ea7-2e5aa88cb672"
  },
  "timestamp": 1612783550980,
  "type": "item.refreshed",
}

Transfers - Transfer account created

This event is triggered when a new sender account has been detected for an item.

Example:

{
  "content": {
    "item_id": 6365343,
    "sender_account_id": 16623323,
    "support": [
      "BULK_TRANSFER"
    ], // table can be empty
    "user_uuid": "16369a41-6d2b-4750-85cd-60e366fbdcb8"
  },
  "timestamp": 1644508779604,
  "type": "transfer.account.created"
}

Transfers - Transfer account updated

This event is triggered when a sender account has been updated (support has changed or account has been deleted).

Example:

{
  "content": {
    "item_id": 6365343,
    "sender_account_id": 16623323,
    "support": [
      "BULK_TRANSFER"
    ], // table can be empty
    "user_uuid": "16369a41-6d2b-4750-85cd-60e366fbdcb8",
    "is_deleted": true,  
  },
  "timestamp": 1644508779604,
  "type": "transfer.account.updated"
}

Transfers - Transfer created

This event is triggered when a transfer has been created (when a user confirm the first step of the Bridge Transfer journey).

Example:

{
  "content": {
    "bulk_id": 123456789, // not in response if null
    "client_reference" :  "INV124", // not in response if null
    "item_id": 6106365,
    "transfer_id": "1b86bc9a-3585-4927-8520-f0de7cfed5bd",
    "user_uuid": "16369a41-6d2b-4750-85cd-60e366fbdcb8"
  },
  "timestamp": 1644506317422,
  "type": "transfer.created"
}

Transfers - Transfer updated

This event is triggered when a transfer has been updated.

Example:

{
  "content": {
    "item_id": 6106365,
    "status": "initiated",
    "transfer_id": "1b86bc9a-3585-4927-8520-f0de7cfed5bd",
    "user_uuid": "16369a41-6d2b-4750-85cd-60e366fbdcb8"
  },
  "timestamp": 1644506320488,
  "type": "transfer.updated"
}