Skip to main content
GET
List events

Authorizations

Authorization
string
header
required

The agency's secret key, sent as Authorization: Bearer <key>. One key per agency.

Query Parameters

after
string | null

The last event id you processed.

Required string length: 1 - 64
limit
integer
default:100

How many events per page, 1 to 500.

Required range: 1 <= x <= 500

Response

A page of events, oldest first.

A page of events.

events
(EnquiryReceived · object | EnquiryQualified · object | EnquiryGoneQuiet · object | EnquiryOptedOut · object | EnquiryAskedForPerson · object | ViewingCantMakeIt · object | ViewingFeedbackCaptured · object | NoteAdded · object | ShowhomeBookingMade · object | ShowhomeBookingChanged · object | ShowhomeBookingCancelled · object | ShowhomeVisitRecorded · object | DevelopmentInterestRegistered · object | WebhookTest · object)[]
required

The events on this page, oldest first.

An enquiry was received: one you sent, or one that reached Signal directly if the agency logs WhatsApp enquiries.

has_more
boolean
required

True when more events follow this page: call again straight away.

next_after
string | null

Pass as after next time: the last event's id, or your own after when there was nothing new. Absent only when there are no events yet and you sent no after.