Skip to main content

Webhooks: AboutToStart

AboutToStart webhooks are triggered before creation or progression of a case is initiated on both the QuickCase UI or the API and they must complete successfully (HTTP 200) before creation or progression can start.

Use cases​

  • Bespoke validation that the creation or progression can be started at this time/in the current state (eg. notification event can only be actioned during business hours)
  • Pre-populate case fields with computed values or data retrieved from 3rd-party

Contract​

Request​

Payload:

{
    "case_details": {
        "id": "string",
        "case_type_id": "string",
        "created_date": "string",
        "last_modified": "string",
        "state": "string",
        "security_classification": "string",
        "case_data": {
            "case_field1": "",
            "case_field2": "",
        },
        "data_classification": {
            "case_field1": "<Security classification>",
            "case_field2": "<Security classification>",
        }
    }
}

Response​

Status: 200

Payload (optional):

{
    "data": {
        "case_field1": "",
        "case_field2": "",
        "case_field3": "",
    },
    "errors": [
        "Error 1",
    ],
    "warnings": [
        "Warning 1",
    ]
}
  • data (optional) - the altered, complete case data to be returned. Any case fields present in the request case_data and omitted from the response data will be missing from the start event payload and would appear empty in the UI. The data returned in the response will be validated against the case type definition, including checks for valid field names and data type correctness. In case of any validation errors, the start event call will fail and the error messages will be returned with HTTP status 422 back to initiator of the start event (UI or API). When data is omitted from the webhook response, then the case data as provided in the request will be used instead.
  • errors (optional) - list of error messages to be returned. If there are any errors, the about to start event call will fail and the error messages will be returned with HTTP status 422 back to initiator of the start event (UI or API).
  • warnings(optional) - list of warning messages to be returned. If there are any warnings, the start event call will fail and the warning messages will be returned with HTTP status 422 back to initiator of the start event (UI or API) unless the about to start URL is configured with query parameter ignore-warning=true.