This event occurs when some data types are updated or created on a pull. This can happen after POLICIES_AVAILABLE
and COMPLETE
.
The following data changes are currently supported:
DRIVER_UPDATED
- when a consumer updates a driverDRIVER_ADDED
- when a consumer adds a driver
Webhook Request Format
The webhook is a POST request with a JSON body that will look like the following:
{
"widget_id": "<WIDGET_ID>",
"team_id": "<TEAM_ID>",
"pull_id": "<PULL_ID>",
"status": "PULLING_DATA",
"meta_data": {... developer-supplied JSON-serializable metadata ...},
"event_type": "DATA_UPDATED",
"account_identifier": "<ACCOUNT_IDENTIFIER>",
"is_monitored": true,
"monitoring": {
"initial_pull_id": "<PULL_ID>", // The ID of the original Pull being monitored
"monitoring_id": "<MONITORING_ID>" // The ID of the Monitoring
},
"data": {
"updates": [ // An array of changes, can contain multiple changes of the same type
{
"type": "DRIVER_UPDATED",
"driver": { // Returns the full Driver schema
"driver_id": "1394c681-ebfe-475d-b390-d7157e33a895",
"first_name": "Clark",
"middle_name": "Joseph",
"last_name": "Kent",
"drivers_license": "123456",
"drivers_license_state": "DC",
"date_of_birth_str": "05/03/1987",
"gender": "MALE",
"marital_status": "SINGLE",
"relationship_to_insured": "INSURED",
"age": null,
"age_on_date": null,
"education": null,
"occupation": "Actor",
"age_licensed": null
}
},
{
"type": "DRIVER_ADDED",
"driver": { // Returns the full Driver schema
"driver_id": "b2762d91-c4c1-4975-bf55-3e06f4bb23de",
"first_name": "Anthony",
"middle_name": "Edward",
"last_name": "Stark",
"drivers_license": "345678",
"drivers_license_state": "NY",
"date_of_birth_str": "05/29/1970",
"gender": "MALE",
"marital_status": "SINGLE",
"relationship_to_insured": null,
"age": null,
"age_on_date": null,
"education": null,
"occupation": "Actor",
"age_licensed": null
}
}
],
}
}
Update Types
Each update object will contain a type
property to indicate what it is for.