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

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"
}

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.

• full_refresh indicates if we fetched the item's full history or not
• refresh_trigger indicates the source of the refresh:
  • connect: refresh triggered by an action within the Connect flow
  • api: refresh triggered by your API integration
  • scheduler: automatic refresh triggered by Bridge

Example:

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

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
• data access has been updated by the end user

Example for an account with data_access enabled:

{
  "content": {
    "account_id": 22908770,
    "balance": 1678.12,
    "data_access":"enabled",
    "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"
}

Example for an account with data_access disabled:

{
  "content": {
    "account_id": 22908770,
    "data_access": "disabled",
    "item_id": 4568477,
    "user_uuid": "766b2f5d-a942-492c-9ea7-2e5aa88cb672"
  },
  "timestamp": 1729694049981,
  "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"
}