This guide will walk you through the various Policy events that may occur when monitoring an insurance policy.
monitoring
enabled. Please
contact the Axle team if you would like to enable this feature!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!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).
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 isActive changes to null
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.