Skip to main content
WEBHOOK

Headers

webhook-id
string
required

The event's id, the same as id in the body. The same on every retry: use it to skip repeats.

webhook-timestamp
string
required

Unix seconds when this delivery attempt was signed. Reject it if it's more than 5 minutes from your clock.

webhook-signature
string
required

v1,, keyed with the base64-decoded secret (the part after whsec_). Several, space-separated, during a rotation.

Body

application/json

A show-home booking was cancelled.

id
string
required

evt_… The same as the webhook-id header. Use it to skip repeats.

timestamp
string<date-time>
required

When it happened, in UTC.

agency_id
string<uuid>
required

Signal's id for the agency.

contact_id
string<uuid>
required

Signal's id for the person. Store it.

contact
EventContact · object
required

Who it's about, so you can find or create them.

viewing_id
string<uuid>
required

Signal's id for the booking.

type
any
required

The event type. Decides the shape of data.

data
ShowhomeBookingData · object
required

What happened. Its shape depends on type.

contact_external_id
string | null

Your contact id, once we know it.

source
string | null

On enquiry events: where the enquiry first reached Signal: daft, myhome, website, phone, walk_in, whatsapp, email or other. For an enquiry you sent, the source you gave.

enquiry_id
string<uuid> | null

Signal's id for the enquiry, when the event is about one.

enquiry_external_id
string | null

Your enquiry id, when the event is about an enquiry you sent us.

viewing_external_id
string | null

Your viewing id, when the event is about a viewing you sent us.

transaction_type
enum<string> | null

sale or letting. New homes are sales with property.development set.

Available options:
sale,
letting
branch_code
string | null

The agency branch, by the codes agreed with the agency.

property
EventProperty · object | null

The property it's about, with your reference when we can match it.

Response

200 - application/json

Any 2xx means delivered. Acknowledge first, process afterwards.