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 body. 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 request body
{
  "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 (see Account for more details).

Additional data parameters (example)
{
  "changes": {
    {
      "type": "UPDATE",
      "key": "email",
      "value": "jsmith@gmail.com",
      "oldValue": "jsmith@hotmail.com"
    }
  }
}

account.disconnected

When Account connection.status is changed to “inactive”, meaning Axle is no longer able to monitor the policies present on the account.

Additional data parameters (example)
{
  "code": "credentials-expired | mfa-expired | account-disabled | account-inaccessible"
}

credentials-expired

Your insurance account cannot be access by Axle due to expired credentials. Please complete Axle via [Ignition URI] to reconnect your account.

mfa-expired

Your insurance account requires additional multi-factor authentication (MFA). Please complete Axle via [Ignition URI] to reconnect your account.

account-disabled

Your insurance account is no longer available. Please complete Axle via [Ignition URI] to connect a different account.

account-inaccessible

Your insurance account can no longer be accessed by Axle. Please retry connecting your account through Axle via [Ignition URI].