Assessment Webhooks

Assessment Lifecycle

Assessments start in a Requested state upon successful creation via API. Modern Insurer sends an email to the property's contact, instructing them to proceed with the assessment.

When the contact completes the assessment, the Assessment moves to Completed.

While an Assessment is in a Requested state, the Assessment can be cancelled via the Cancel assessment endpoint. This action moves the Assessment to a Cancelled state.

Assessment Lifecycle Diagram

Webhook Events

EventType	Description
assessment.completed	The assessment has been successfully completed.
assessment.cancelled	The assessment has been cancelled.

Sample Payloads

assessment.completed

{
  "eventType":"assessment.completed",
  "assessmentId":"676ee72e11ea12e6eb282c22",
  "propertyId": "676ee72e11ea12e6eb282c22",
  "report":{
    "filename":"069853_brochurerolloverapp_en.pdf",
    "uploadDate":"2024-12-27T17:44:30.572Z",
    "url":"https://mxoiflstnghwqac9.public.blob.vercel-storage.com/069853_brochurerolloverapp_en-uj6zcA1eGW9TvqsHV87NUxx90g8KyV.pdf"
  },
  "completedAt": "2024-12-27T17:44:30.572Z"
}

assessment.cancelled

{
  "eventType":"assessment.cancelled",
  "inspectionId":"676f879211ea12e6eb282cb7"
}