Data Sync (Tokenisation)
- 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
API object
{
event: 'mono.events.reauthorisation_required',
data: {
account: {
_id: '5fbcde8f8699984153e65537'
}
}
}
Fields for mono.events.reauthorisation_required webhook
Field | description | type |
event | The webhook event action that triggered the webhook, e.g. mono.events.account_reauthorized | string |
data | All information related to this specific webhook | object |
data.account | A nested object with all account data | object |
data.account._id | The 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
API object
{
event: 'mono.events.account_reauthorized',
data: {
account: {
_id: '5fbcde8f8699984153e65537'
}
}
}
Fields for mono.events.reauthorisation_required webhook
Field | description | type |
event | The webhook event action that triggered the webhook, e.g. mono.events.account_reauthorized | string |
data | All information related to this specific webhook | object |
data.account | A nested object with all account data | object |
data.account._id | The 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.
mono.events. sync_failed
API object
{
event: 'mono.events.sync_failed',
data: {
account: {
_id: '5fbcde8f8699984153e65537'
}
}
}
Fields for mono.events.sync_failed webhook
Field | description | type |
event | The webhook event action that triggered the webhook, e.g. mono.events.account_reauthorized | string |
data | All information related to this specific webhook | object |
data.account | A nested object with all account data | object |
data.account._id | The unique identifier for the member which has new or updated transaction data | string |
- 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.
mono.events.account_synced
API object
{
event: "mono.events.account_synced",
data: {
account: "6176846672402e538139971b",
updated: true // or false
}
}
Fields for mono.events.account_synced webhook
Field | description | type |
event | The webhook event action that triggered the webhook, e.g. mono.events.account_synced | string |
data | All information related to this specific webhook | object |
data.account | The unique identifier for the user which has new or updated transaction data | string |
data.updated | This field returns a true or false value indicating whether new data is found or not | boolean |
Updated about 2 months ago
What’s Next