Skip to main content
WEBHOOK
onboardingCompleted
{
  "event": "onboarding_completed",
  "organisationId": "123e4567-e89b-12d3-a456-426614174000",
  "sentAt": "2024-01-15T10:30:00.000Z",
  "data": {
    "caseId": "456e7890-e12b-34d5-a678-426614174001",
    "reference": "PC-2024-001",
    "caseType": "purchase",
    "createdAt": "2024-01-15T09:00:00.000Z",
    "branchId": "789e0123-e45b-67d8-a901-426614174002",
    "feeEarnerId": "012e3456-e78b-90d1-a234-426614174003",
    "notificationType": "OnboardingCompleted",
    "propertyPrice": 25000000,
    "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",
    "audience": "referring_estate_agent",
    "referredToOrganisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Body

application/json

Case data and notification discriminator

​
event
enum<string>
required

The type of event that triggered the webhook

Available options:
onboarding_completed
Example:

"onboarding_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