History events

When certain events occur in InsuranceSuite they are automatically recorded. Each history event is stored as a CustomHistory type. You can retrieve these history events by using the history-events endpoint.

  • GET /common/v1/history-events/{historyEventId}

The following section provides an example using this endpoint.

Retrieve a single history event

You can retrieve a single history event by using the history-events endpoint in the common API. To use this endpoint you must first retrieve the historyEventId from the history-events endpoint on the relevant object, such as the contacts object in the ContactManager Contact API. (For more information on the Contact API, see History events for ContactManager.)

The information retrieved in this example is from an account change history event where the account changed from pending to active.

Command

GET /common/v1/history-events/S-d_RRz9cG9bhqcfVN2xC

Response

{
    "data": {
        "attributes": {
            "account": {
                "displayName": "C000478975",
                "id": "SaDgS3XDMmUlTYlw-HNoI",
                "type": "Account",
                "uri": "/account/v1/accounts/SaDgS3XDMmUlTYlw-HNoI"
            },
            "customType": {
                "code": "acct_changed",
                "name": "Account changed"
            },
            "description": "Pending account became active",
            "eventTimestamp": "2024-06-03T23:03:05.992Z",
            "historyType": {
                "code": "custom",
                "name": "Custom"
            },
            "id": "SJj0sm_oXm7aZUXrKuWxF",
            "user": {
                "displayName": "Super User",
                "id": "default_data:1",
                "type": "User",
                "uri": "/admin/v1/users/default_data:1"
            }
        },
    …
}