Service request history events

Whenever a change is made to a service request, the change is recorded in a history event. This includes changes made from a third-party vendor portal or other external system.

For example, a history event is created when the service request is created. Another event is created when a quote is added. The most important information recorded includes a date/time stamp, the ClaimCenter user or insured that made the change, and a description of the change. The description varies depending on the data that was changed. For example, adding a quote includes the quote amount.

Service request history events are also known as histories in Cloud API.

Querying for history events

The following Claim API endpoints can be used to request information about service request history events (histories):

Endpoint Response
GET /claims/{claimId}/service-requests/{serviceRequestId}/histories All history events for the specified service request.
GET /claims/{claimId}/service-requests/{serviceRequestId}/histories/{serviceRequestHistoryId} The specified history event.

For example, the following request retrieves details on a history event with ID cc:SYJdu78OzhM9HaeOJ3C8g where a service's reference number was updated to 125:

Command
GET claim/v1/claims/demo_sample:1/service-requests/cc:Sv7suSH2Vse5mi4tes404/histories/cc:SYJdu78OzhM9HaeOJ3C8g
Response
{
    "data": {
        "attributes": {
            "description": "Reference number updated to: 125",
            "expectedQuoteCompletionDateChanged": false,
            "expectedServiceCompletionDateChanged": false,
            "id": "cc:SYJdu78OzhM9HaeOJ3C8g",
            "instructionChanged": false,
            "progressChanged": false,
            "quoteStatusChanged": false,
            "sequence": 4,
            "timestamp": "2025-03-09T21:47:38.895Z",
            "user": {
                "displayName": "Andy Applegate",
                "id": "demo_sample:1",
                "type": "User",
                "uri": "/admin/v1/users/demo_sample:1"
            }
        },
        "checksum": "0",
        "links": {
            "self": {
                "href": "/claim/v1/claims/demo_sample:1/service-requests/cc:Sv7suSH2Vse5mi4tes404/histories/cc:SYJdu78OzhM9HaeOJ3C8g",
                "methods": [
                    "get"
                ]
            }
        }
    }
}