Events and payloads

You can create webhooks that subscribe to the events listed on this page. For how to register an endpoint, see Creating webhooks, or register one over the API using the event name below as the eventType.

Events

Event	Triggered when
`NEW_REVIEW`	A new review is posted for your firm.
`NEW_ENQUIRY_CLIENT_ASSIST`	A new Client Assist enquiry is sent to your firm. Needs Client Assist.

New review

Payload

The body is the same review object returned by GET /api/v2/reviews/{reviewId}.

payload


{
  "id": 0,
  "reviewDate": "2026-01-31",
  "title": "string",
  "text": "string",
  "rating": 0,
  "workArea": "string",
  "mainWorkAreaName": "string",
  "subWorkAreaName": "string",
  "reference": "string",
  "satisfied": false,
  "recommended": false,
  "response": "string",
  "responseBy": "string",
  "responseDate": "2026-02-01T09:30:00",
  "stats": {
    "initialImpressions": 0,
    "legalKnowledge": 0,
    "valueForMoney": 0,
    "approachability": 0,
    "documentationAccuracy": 0,
    "communication": 0
  },
  "professionals": [
    {
      "id": 0,
      "name": "string",
      "profileImage": "string",
      "regulatorId": "string",
      "url": "string"
    }
  ],
  "reviewerName": "string",
  "reviewerProfilePicture": "string",
  "reviewerVerified": false,
  "source": "string",
  "helpfulCount": 0,
  "customQuestions": [
    {
      "question": "string",
      "answer": "string"
    }
  ]
}

Object

Every field is documented under the review object.

New Client Assist enquiry

Sent once per enquiry, when your firm is first notified of it: when the client finishes, or when they stop before finishing and the enquiry is sent to you as it stands. Answers the client adds afterwards are not sent again; fetch the enquiry with GET /api/v2/client-assist/{id} to see them.

Payload

The body is the same enquiry object returned by GET /api/v2/client-assist/{id}.

payload


{
  "id": "RS-4f1c2a9be07d3e18",
  "status": "SUBMITTED",
  "clientAssistPlus": false,
  "createdDate": "2026-08-01T10:22:46",
  "clientName": "Jane Doe",
  "clientEmail": "jane.doe@example.com",
  "clientPhone": "+447700900123",
  "contactRevealed": false,
  "contactRevealedAt": null,
  "message": "I want to start divorce proceedings as soon as possible.",
  "timeframe": "PERIOD_1_2",
  "workAreaId": 295,
  "workArea": "Divorce",
  "mainWorkAreaId": 665,
  "mainWorkArea": "Family Law",
  "officeId": 65196,
  "officeName": "Leeds",
  "professionalId": null,
  "professionalName": null,
  "rejectedAt": null,
  "rejectReason": null,
  "rejectDetails": null,
  "reportedAt": null,
  "reportReason": null,
  "reportDetails": null,
  "questions": [
    {
      "question": "Are there children under 18 who are subject to parental responsibility?",
      "answer": "No"
    }
  ]
}

Object

Every field is documented under the enquiry object.