Skip to main content
WEBHOOK
taskCompleted
{
  "event": "task_completed",
  "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sentAt": "2023-11-07T05:31:56Z",
  "data": {
    "caseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reference": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "feeEarnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "taskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "taskType": "<string>",
    "propertyPrice": 123,
    "address": {
      "line_1": "<string>",
      "line_2": "<string>",
      "line_3": "<string>",
      "post_town": "<string>",
      "county": "<string>",
      "postcode": "<string>",
      "uprn": "<string>"
    },
    "archivedAt": "2023-11-07T05:31:56Z"
  }
}

Body

application/json

Case context and completed task identifiers

​
event
enum<string>
required

The type of event that triggered the webhook

Available options:
task_completed
Example:

"task_completed"

​
organisationId
string<uuid>
required

ID of the organisation that owns the resource

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
sentAt
string<date-time>
required

Timestamp when the webhook was sent

Example:

"2024-01-15T10:30:00.000Z"

​
data
object
required

Event-specific data payload

Response

200

Return a 200 status to indicate that the webhook was received successfully