The list of available webhooks along with the response schema are defined below:
test_endpoint
This event can be used to verify the endpoint configuration.
{
"status": "SUCCESS",
"message": "Endpoint is working",
"event_id": "eve_12345678900",
"event_type": "test_event"
}
sync.full_policy_data.success
Send list of policies with the full policy structured data in payload when available for the sync. The keys "event_type" and "event_id" will be shared along with the response as linked below on the Schema Response.
Frequency: Once per Sync
Property | Type | Description | Nullable |
---|---|---|---|
event_type | String | Name of event for which message has been sent to configured endpoint. | No |
event_id | String | Unique identification for each webhook message that has been sent to configured endpoint. | No |
Other Response Payload: full_policy_data.success
Other than the event_type and event_id properties, the response will contain data based on the Incremental API response schema which is linked above.
sync.basic_policy_data.success
Sends list of policies with the basic policy structured data in payload when available for the sync. The keys "event_type" and "event_id" will be shared along with the response as linked below on the Schema Response.
Frequency: Once per Sync
Property | Type | Description | Nullable |
---|---|---|---|
event_type | String | Name of event for which message has been sent to configured endpoint. | No |
event_id | String | Unique identification for each webhook message that has been sent to configured endpoint. | No |
Other Response Payload: basic_policy_data.success
Other than the event_type and event_id properties, the response will contain data based on the Incremental API response schema which is linked above.
sync.policy_documents.success
Sends list of policies with the full policy structured data in payload when available for the sync. The keys "event_type" and "event_id" will be shared along with the response as linked below on the Schema Response.
Frequency: Once per Sync
Property | Type | Description | Nullable |
---|---|---|---|
event_type | String | Name of event for which message has been sent to configured endpoint. | No |
event_id | String | Unique identification for each webhook message that has been sent to configured endpoint. | No |
Other Response Payload: policy_documents.success
Other than the event_type and event_id properties, the response will contain data based on the Incremental API response schema which is linked above.
sync.policy_holder_data.success
Sends list of policies with the policy holder structured data in payload when available for the sync. The keys "event_type" and "event_id" will be shared along with the response as linked below on the Schema Response.
Frequency: Once per Sync
Property | Type | Description | Nullable |
---|---|---|---|
event_type | String | Name of event for which message has been sent to configured endpoint. | No |
event_id | String | Unique identification for each webhook message that has been sent to configured endpoint. | No |
Other Response Payload: policy_holder_data.success
Other than the event_type and event_id properties, the response will contain data based on the Incremental API response schema which is linked above.