Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.axle.insure/llms.txt

Use this file to discover all available pages before exploring further.

Once an insurance policy is connected through an Ignition session, Axle can monitor that policy 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.
Policy events are only sent for insurance policies 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, account, ref (Policy object identifier), user (optionally specified when generating Ignition token), and metadata (optionally specified when generating Ignition token).
Example webhook payload
{
  "id": "<event_id>",
  "type": "policy.modified",
  "data": {
    "client": "<client-id>",
    "account": "<account-id>",
    "ref": "pol_Z4ni-JHBvkn9PlKJHPEwk",
    "user": {},
    "metadata": {},
    ...{ parameters }
  },
  "createdAt": "2022-10-05T14:48:00.000Z"
}

​
policy.modified

This event type indicates details on the Policy changed. Refer to Policy for more details on the fields that can be modified.
Axle performs safety checks on policy modifications before sending a policy.modified event. This may cause a short delay between when policy information was refreshed from the carrier and when you receive notification of the event.

​
policy.renewal-available

This event type indicates renewal policy is available for retrieval. Refer to Policy for more details on available options and how to retrieve it.
If the Get Policy API endpoint returns a 404, it means no renewal policy is available. We recommend calling the API again without the term query parameter OR passing in term=current as a query parameter.

​
Special Policy Changes

If a policy.modified event indicates that a policy’s isActive field has changed to null, then the policy may have been removed from the account. It is recommended to reach out to the user to re-connect the policy for the existing account or link a new account.