File Events

This endpoint is used to receive events associated with a file.

Response Schema

AttributeTypeDescription
statusCodeIntegerStandard HTTP response code. Status codes are outlined in the Errors section of this API reference.
messageStringA human-readable message providing more details about the status code. Messages are outlined in the Errors section of this API reference.
dataArray of ObjectsAn array of file events that are associated with the requesterReferenceId. The individual attributes associated with each object are outlined below for the first array element.
data[0].messageStringThe file event message. Possible values:

"Case File has been created" - indicates that a new file (i.e. requesterReferenceId) has been successfully created.
data[0].timeStampStringThe date and time of the event (e.g. 2021-03-12T17:22:25)
errorsArray of StringsAn array of human-readable error messages, if available (null otherwise). Unique errors associated with this endpoint, if applicable, are shown in the example response in the right column with the corresponding HTTP status code.
Language
Credentials
OAuth2