This event is triggered when the policy data for an insurance policy becomes available. If the end-user has no insurance policies, this event will not trigger. If the end-user has 5 insurance policies, you will receive 5 POLICY_AVAILABLE
webhook requests.
Webhook Request Format
The webhook is a POST request with a JSON body that will look like the following:
{
"widget_id": "<WIDGET_ID>",
"pull_id": "<PULL_ID>",
"status": "PULLING_DATA",
"meta_data": {... developer-supplied JSON-serializable metadata ...},
"event_type": "POLICY_AVAILABLE",
"data": {
"policy_id": "<POLICY_ID>", // Returned with the POLICY_AVAILABLE event. policy_id of the Policy that is available
"policy_type": "<POLICY_TYPE>", // Returned with the POLICY_AVAILABLE event. Policy type
}
}
Data key | Data description |
---|---|
policy_id | The ID for the policy that is now available. |
policy_type | The type of policy that is now available. Reference the Policy Schema for valid policy_type's. |