Configure Ignition to receive webhooks
Ensure that the request made to generate an Ignition token includes the webhook URL where you would like to receive notifications.
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.
Request Sample: cURL
2
Store accessToken for future access
The
accessToken and account or policy you received via Exchange Token must be stored by your application to access updated Account or Policy objects.If a returning user links a new insurance account, a new access token will be returned. You should compare the new token against the one you have stored for this user and determine if the old access token
needs to be de-scoped. See Descope Token for more details.Alternatively, if a returning user links the same insurance account, the same access token will be returned. This would re-connect a previously disconnected monitored account.Process Account and Policy events
Notifications will be triggered by the following events and will need to be processed by your application.
- Account events
account.modified: Updates made to identifying details for the insurance account (e.g., name, email, phone)account.retrying: Axle lost its connection to the insurance carrier and is trying to re-establish itaccount.reconnected: Axle re-established an active connection and resumed monitoring the accountaccount.disconnected: The account and any connected policies are no longer being monitored by Axle
- Policy events
policy.modified: Updates made to insurance policy, such as policy cancellation or change in coveragespolicy.renewal-available: A renewal policy is available to retrievepolicy.result-detail-changed: Axle changed how it retrieves the policy, such as switching from the user’s login to a policy lookup
Retrieve Account or Policy object
For security, Account and Policy events do not include the entire Account and Policy objects, but include a
ref to identify which Account or Policy is impacted by this event. You can retrieve the object via this identifier and the accessToken stored in your application.Axle will continue refreshing the Account and Policy objects even if these
events are not triggered. Refer to the
refreshedAt date on the Account and
Policy to determine when the data was last successfully retrieved from the
insurance carrier.Validate against requirements and contact user if action is required
policy.modified: Validate updated Policy against your application’s requirements. If policy does not meet requirements, ask user to complete new Axle Ignition session.account.disconnected: Ask user to complete new Axle Ignition session. See Account events for additional guidance on messaging.policy.result-detail-changed: Retrieve the updated Policy and validate it against your application’s requirements. See Changes to how a policy is monitored.Key considerations:- If the user reconnects the same insurance account and policy, Axle will merge the updated information with any existing Account or Policy objects.
If needed, stop monitoring for user's accessToken
When monitoring is no longer required for a specific user or entity, such as when a loan is no longer being tracked or a driver is offboarded from a platform, you can de-scope monitoring from the
accessToken stored for that user or entity. See Descope Token for more details.Changes to how a policy is monitored
TheresultDetail on a Policy and Account shows how Axle retrieves its data. See resultDetail for each value. While a policy is monitored, resultDetail can change:
- User login to policy lookup. If Axle can no longer access the user’s insurance account, it may keep monitoring the policy through a policy lookup instead of disconnecting the account.
resultDetailchanges fromuser-portal-loginto a policy lookup value, such aspolicy-lookup. - Policy lookup to user login. If the user later reconnects the same insurance account and policy through Ignition,
resultDetailchanges back touser-portal-login.
policy.result-detail-changed event.