Webhook Payload

Understand the webhook JSON body, API version behavior, AI Analysis results, and a complete ready-for-review payload example.

Use the webhook body to identify the event, read the full inspection, and inspect an associated operation when one exists.

Top-level fields

Every webhook body is JSON with these three top-level fields:

FieldTypeDescription
actionstringThe event name, such as ACTION_STATUS_READY_FOR_REVIEW. See Webhook Actions for event descriptions.
resultobjectThe full inspection, in the same shape as the inspection object in the result field of GET /v3/inspections/{inspectionId}. Use that reference for the inspection field list.
operationobject or nullThe associated operation when the event is tied to one, such as a status change; otherwise null. See GET /v3/operations/{operationId} for the operation object's shape.

The webhook's result is the inspection object itself, not the API response wrapper containing response_code, message, and api_version.

API version

The payload uses the API version configured on the webhook through vision_api_version. The default is v3.

Webhooks configured for v2 receive v2 field names and event names, not the v3 names shown in this page's example. Use the V2 to V3 Migration guide to map legacy fields when updating your receiver.

AI Analysis results

Vision includes AI Analysis results in result only for these events:

  • ACTION_STATUS_READY_FOR_REVIEW
  • ACTION_AI_ANALYSIS_FAILED

Do not expect AI Analysis results in other webhook events. When processing either event, check the returned analysis state and results rather than assuming the analysis succeeded. See the ai_status and ai_status_details fields in Get an inspection for their definitions.

Example: inspection ready for review

This complete JSON body illustrates a v3 ACTION_STATUS_READY_FOR_REVIEW delivery for an inspection with one captured photo. The inspection fields follow the Get an inspection response schema and field examples. Names, contact details, identifiers, and image URLs are fictional; the example.com URLs do not serve inspection images.

This example has no associated operation, so operation is null. Fields present in an inspection depend on its populated data; this example does not enumerate every optional inspection field.

{
  "action": "ACTION_STATUS_READY_FOR_REVIEW",
  "result": {
    "id": 12345,
    "created_at": "2026-11-18T14:00:00.000Z",
    "updated_at": "2026-11-18T14:16:00.000Z",
    "customer_first_name": "Alex",
    "customer_last_name": "Example",
    "customer_email_address": "[email protected]",
    "customer_phone_country": "US",
    "customer_phone_number": "2025550142",
    "customer_address": null,
    "customer_address_lat": null,
    "customer_address_lng": null,
    "custom_field_values": ["EXAMPLE-CLAIM-001"],
    "send_methods": {
      "text": true,
      "email": true
    },
    "organization": {
      "id": 100,
      "name": "Example Organization",
      "is_mfa_required": true
    },
    "organization_team": {
      "id": 200,
      "name": "Example Claims Team",
      "shortname": "example-organization-claims",
      "slug": "claims"
    },
    "inspection_type": {
      "id": 300,
      "name": "Example Exterior Inspection",
      "custom_fields": [
        {
          "label": "Claim reference",
          "entry_method": "ENTRY_METHOD_TEXT",
          "is_required": true
        }
      ]
    },
    "finished_at": "2026-11-18T14:15:00.000Z",
    "ready_at": "2026-11-18T14:16:00.000Z",
    "closed_at": null,
    "is_expired": false,
    "outcome": null,
    "verification_result": "pass",
    "photo_counts": {
      "total": 1,
      "pass": 1,
      "fail": 0,
      "warn": 0
    },
    "photos": [
      {
        "id": "40001",
        "inspection_id": 12345,
        "created_at": "2026-11-18T14:14:00.000Z",
        "device_time": "2026-11-18T14:14:00.000Z",
        "local_ts": "11/18/26 9:14am EST",
        "type": "image",
        "verification_code": "EXAMPLEPHOTO01",
        "is_deleted": false,
        "is_existing_image": false,
        "is_verified": true,
        "lat": "38.9072",
        "lng": "-77.0369",
        "image": "https://example.com/inspection-images/40001.jpg",
        "original_image": "https://example.com/inspection-images/40001-original.jpg",
        "list_item_id": 50001,
        "customer_note": "Front exterior of the property.",
        "internal_note": null
      }
    ],
    "list": {
      "id": 500,
      "name": "List for Inspection 12345",
      "created_at": "2026-11-18T14:00:00.000Z",
      "updated_at": "2026-11-18T14:14:00.000Z",
      "items": [
        {
          "id": 50001,
          "name": "Front exterior of the property",
          "type": "PHOTO",
          "is_required": true,
          "order": 1,
          "created_at": "2026-11-18T14:00:00.000Z",
          "updated_at": "2026-11-18T14:14:00.000Z",
          "photos": ["EXAMPLEPHOTO01"],
          "question": null
        }
      ]
    },
    "ai_status": "pass",
    "ai_status_details": {
      "summary": "The requested front exterior photo is present with no inconsistencies detected.",
      "list_items": [
        {
          "list_item_id": 50001,
          "status": "pass",
          "status_reason": "COMPLETE_WITH_NO_INCONSISTENCIES",
          "summary": "The photo shows the front exterior of the property."
        }
      ]
    }
  },
  "operation": null
}

In this delivery, result.id identifies inspection 12345, and action tells your receiver it is ready for review. The example's ai_status is pass; other deliveries can contain analysis results that require review or indicate failure.

Handle new fields and actions

Treat unknown fields and unknown action names as non-breaking changes. Vision adds fields and actions over time.

  • Read the fields your integration needs and ignore additional fields, including fields inside nested objects.
  • Process action names your integration recognizes. For an unknown action, skip action-specific processing rather than rejecting the delivery.
  • Handle operation: null without trying to read operation properties.
  • Do not require AI Analysis results on events that do not include them.

Verify webhook signatures before processing deliveries, including unknown actions. See Webhook Setup for verification and delivery-response guidance.


Did this page help you?