Claim Webhooks

Structure

Each webhook is sent as a POST request, with a JSON body - similar to regular API responses from XClaim.

Each webhook body will have two key properties:

• event

• payload

Event will specify the type of webhook event, and the payload will contain the relevant object (often containing other related objects).

Claim Webhooks

Webhooks will be sent for the following events:

• claim.status-update

• claim.status-category-update

• claim.deleted

Note that for most integrations, the status-category-update is the most relevant webhook type. This is also referred to as the external status, and essentially represents one of a small list of high-level statuses which a claim can be in at any point in time. These are described in the Appendix.

Example webhook body:

{
  "event": "claim.status-category-update",
  "payload": {
    "id": "099c4df7-cf47-4fb8-baf7-4a1d64d1fd56",
    "claimReference": "HVGCU-B78QJ-CLA",
    "bookingReference": "518B-3H5Q-INS",
    "status": {
      "category": "Action Required"
    },
    "claimDetails": []
  }
}

The id inside payload is the claim uuid.

Note: The exact set of attributes passed may differ from integration to integration. Please test before using, and if you require further data you think you are not getting, please talk to the integration team.

You can see a full list of status categories here.

Misc Notes

• If you are using a secure (https) URL to receive webhooks, make sure it has a valid SSL certificate. This is particularly important on your testing environments for example - otherwise the webhooks will not be sent.

• Please respond to the webhook http request with any HTTP 2xx response code upon successful receipt. Failure to do so will result in the webhook being re-sent multiple times.