Webhook Events

Events are actions initiated by the API that triggers the webhook automatically, when this happens, Curacel submits a POST request to the designated Webhook URL with information about the event transactions.

Event	Description
assessments.created	This is sent when the vehicle assessments result is available. This hook will contain the results of the assessment

Below are examples data contained in the webhook events.

Assessment Created

{
  "event": "vehicle_assessments.created",
  "data": {
    "id": 18,
    "images": [
      {
        "id": 8,
        "vehicle_part": "front",
        "processing_status": "approved",
        "url": "http://auto-api.test/storage/assessments/GjLXcUkyCS65a1475fcf785.jpg",
        "created_at": "2024-01-12T14:06:23.000000Z",
        "updated_at": "2024-01-16T04:52:47.000000Z",
        "annotated_url": "http://auto-api.test/storage/annotated_image/S6mQTqtK8krHClNu65a60b9f4bfbc.jpg",
        "annotations": [
          {
            "id": 44,
            "part": "Bonnet",
            "type": "Crack",
            "severity": "High"
          }
        ]
      },
      {
        "id": 9,
        "vehicle_part": "left",
        "processing_status": "approved",
        "url": "http://auto-api.test/storage/assessments/ZFTSPDIhB465a14762175a6.jpg",
        "created_at": "2024-01-12T14:06:26.000000Z",
        "updated_at": "2024-01-16T04:52:47.000000Z",
        "annotated_url": "http://auto-api.test/storage/annotated_image/c5sBoziXSgJhilcI65a60b9f6f75b.jpg",
        "annotations": [
          {
            "id": 45,
            "part": "Bumper End",
            "type": "Dent",
            "severity": "Medium"
          }
        ]
      },
      {
        "id": 10,
        "vehicle_part": "right",
        "processing_status": "approved",
        "url": "http://auto-api.test/storage/assessments/vnxoALtucV65a147636afe5.jpg",
        "created_at": "2024-01-12T14:06:27.000000Z",
        "updated_at": "2024-01-16T04:52:47.000000Z",
        "annotated_url": "http://auto-api.test/storage/annotated_image/SH3d79TkcY5ms0nm65a60b9f74478.jpg",
        "annotations": []
      },
      {
        "id": 11,
        "vehicle_part": "rear",
        "processing_status": "approved",
        "url": "http://auto-api.test/storage/assessments/bfyFJbFvsU65a14764dc754.jpg",
        "created_at": "2024-01-12T14:06:28.000000Z",
        "updated_at": "2024-01-16T04:52:47.000000Z",
        "annotated_url": "http://auto-api.test/storage/annotated_image/sGEgwre4hC2wexDq65a60b9f79c84.jpg",
        "annotations": []
      }
    ]
  }
}

Webhook Events

Webhook Events​

Webhook Events