Account events
This guide will walk you through the various Account events that may occur when monitoring an insurance account.
Once an insurance account is connected through an Ignition session, Axle can monitor that account for updates. These updates will trigger events that are sent from Axle to your systems via webhook or to your organization via communication channels such as email.
Account events are only sent for insurance accounts connected through Axle
Ignition sessions that are configured with monitoring enabled. Please
contact the Axle team if you would like to enable this feature!
Webhooks
You must specify a webhookUri when generating an Ignition token to receive
webhook events. See Start Ignition
for more details.
A POST request will be sent to the webhookUri with the following payload. All events will include client, ref (Account object identifier), user (optionally specified when generating Ignition token), and metadata (optionally specified when generating Ignition token).
{
"id": "<event_id>",
"type": "account.modified",
"data": {
"client": "<client-id>",
"ref": "acc_Z4ni-JHBvkn9PlKJHPEwk",
"user": {},
"metadata": {},
...{ parameters }
},
"createdAt": "2022-10-05T14:48:00.000Z"
}
account.modified
When identifying details on the Account change. Refer to Account for more details on the attributes that can be modified.
account.disconnected
When Account connection.status is no longer “active”, meaning Axle is no longer able to monitor the policies present on the account.
{
"status": "credentials-expired | mfa-expired | account-disabled | account-inaccessible"
}
credentials-expired
The user has changed their login credentials or their insurance account requires a periodic update of their login credentials.
mfa-expired
The user’s insurance account is has re-triggered multi-factor authentication, requiring additional authentication for Axle to regain access.
account-disabled
The user’s insurance account has been disabled by the insurance carrier due to inactivity or policy expiration.
account-inaccessible
The user’s insurance account unexpectedly cannot be accessed by Axle. The Axle team has been notified and will immediately escalate for resolution. This process may not be immediate; therefore, it is recommended to set a policy of at least one month before reaching out to the user to reconnect their account.