New Payment-related Webhook Events
We have added the following webhook events:
Event Descriptions
Policy Cancellation Initiated
The Policy Cancellation Initiated webhook event may be emitted when Root initiates a cancellation for a policy. Root can initiate cancellations for several reasons; however, this event is currently only scoped to the non_payment type and will not be emitted for other types. Therefore, Root may emit this event for a policy if the customer's account has overdue funds associated with it and Root has started the scheduled cancellation process for the policy due to non-payment.
If the customer does not pay the outstanding balance for their policy before the scheduled cancellation date, then the policy will be canceled unless a new cancellation reason takes precedence or Root declines to execute the cancellation for any reason.
Policy Payment Succeeded
The Policy Payment Succeeded webhook event will be emitted after a successful payment. A successful payment can mean one of the following:
- Root successfully processes a scheduled policy payment (e.g. through automatic payments)
- The customer pays directly in the Root app or on web a full upcoming payment, a late payment, or a payment to change their policy (e.g. an endorsement or billing change)
- The customer pays a portion of their monthly or full-term bill
In many cases, a successful payment after a non-payment cancellation has been initiated will result in the cancellation being prevented; however, that is not always the case if the customer does not pay their full outstanding balance by the scheduled cancellation date.
Intended Integration Use-case
Root intends for these webhooks to help the subscriber determine if a customer has a pending cancellation due to non-payment and if the cancellation will likely be prevented due to a subsequent successful payment.
Sample Sequence of Events
- Root fails to process a scheduled payment for a policy
- Root initiates a cancellation with an effective date in the future
- Root emits the Policy Cancellation Initiated webhook event
- Subscriber responds to the webhook event by flagging the policy as having a pending cancellation for non-payment
- At a later date, the customer attempts to pay their outstanding balance
- Root successfully processes the payment
- Root emits the Policy Payment Succeeded webhook event
- Subscriber responds to the webhook event by flagging the policy as no longer having a pending cancellation for non-payment