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.

Custom webhook headers can be configured to support uses cases like authentication. Please contact the Axle team if you would like to configure custom webhook headers!

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).

Example webhook payload
{
  "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

This event type indicates details on the Account changed. Refer to Account for more details on the fields that can be modified.

​
account.disconnected

This event type indicates the Account connection.status is no longer “active”, meaning Axle is no longer able to monitor the policies present on the account.

Additional data parameters (example)
{
  "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, despite multiple attempts to reach the insurance carrier. The Axle team has been notified and will immediately escalate for resolution. It is recommended to reach out to the user to reconnect their account.