Overview
The following pages describe the various webhook evevnts you can subscribe to in Claims Manager, and what information you can expect to receive from them. The payload you reveive from any webhook subscription will always contain the following common fields. They provide context around what the event was and where to go in the Claims Manager API to receive more information.
| Parameter Name | Description | Type | Example Data |
|---|---|---|---|
event
|
The webhook event type that caused this message to be sent | string | Transaction |
action
|
The action that caused this message to be sent | string | Create |
incidentId
|
The Claims Manager incident id for the record that triggered the event | int | 123456 |
resource
|
The relative resouce url for further information in the CLaims Manager API. Append this to the base url for the relevant environment. Authentication is required to follow this url. | string | /incident/123456 |
createdDateTime
|
The date and time that the event was triggered in UTC. | string($date) | 2023-08-22T15:04:23.423 |
data
|
An object contatining the payload of the relevant webhook event. See individual pages in this section for individual details. | object |
Webhook payloads will, by design, not include any PII data. Their purpose is to alert you to something that has happened in Claims Manager. If you need
further information about what has occurred you will need to build your application in such a way as to follow the resource url and extract
the information you require from the Claims Manager API.