mono-logo

Webhook Events

Last updated May 19th, 2022

Data Sync (Tokenization)

1 When Data Sync occurs and a particular connected account has Multi-Factor Authentication (MFA) enabled, a webhook event, mono.events.reauthorisation_required is sent with a payload that contains the Account ID. With this ID, you must then retrieve a re-auth code with the reauthorise API endpoint. This re-auth code can then be passed to the Re-authorise Widget.

mono.events.reauthorisation_required

Request

12345678
{
  event: 'mono.events.reauthorisation_required',
  data: {
    account: {
      _id: '5fbcde8f8699984153e65537'
    }
  }
}

Fields for mono.events.reauthorisation_required webhook

FieldDescriptionType
eventThe webhook event action that triggered the webhook, e.g. mono.events.account_reauthorized.string
dataAll information related to this specific webhook.object
data.accountA nested object with all account data.object
data.account._idThe unique identifier for the member which has new or updated transaction data.string

2 Once a successful account reauthorisation has taken place, mono.events.account_reauthorized event is sent with a payload containing the Account ID for the purpose of confirmation.

mono.events.account_reauthorized

Request

12345678
{
  event: 'mono.events.account_reauthorized',
  data: {
    account: {
      _id: '5fbcde8f8699984153e65537'
    }
  }
}

Fields for mono.events.account_reauthorized webhook

FieldDescriptionType
eventThe webhook event action that triggered the webhook, e.g. mono.events.account_reauthorized.string
dataAll information related to this specific webhook.object
data.accountA nested object with all account data.object
data.account._idThe unique identifier for the member which has new or updated transaction data.string

3 Once an Automatic data sync process has failed, mono.events. sync_failed event is sent with a payload containing the Account ID for the purpose of confirmation.

Request

12345678
{
  event: 'mono.events.sync_failed',
  data: {
    account: {
      _id: '5fbcde8f8699984153e65537'
    }
  }
}

Fields for mono.events.sync_failed webhook

FieldDescriptionType
eventThe webhook event action that triggered the webhook, e.g. mono.events.account_reauthorized.string
dataAll information related to this specific webhook.object
data.accountA nested object with all account data.object
data.account._idThe unique identifier for the member which has new or updated transaction data.string

4 The account synced event (mono.events.account_synced) gets sent for automatic refresh only, which takes place at midnight. A boolean field gets returned indicating whether new data is found or not. Also most importantly, the Account ID gets sent as well in the payload.

Request

1234567
{
    event: "mono.events.account_synced",
    data: {
      account: "6176846672402e538139971b",
      updated: true // or false
    }
}

Fields for mono.events.account_synced webhook

FieldDescriptionType
eventThe webhook event action that triggered the webhook, e.g. mono.events.account_synced.string
dataAll information related to this specific webhook.object
data.accountThe unique identifier for the user which has new or updated transaction data.string
data.updatedThis field returns a true or false value indicating whether new data is found or not.boolean

Did this page help you?