Get Sample Events

Recent records from your organisation, each wrapped in the envelope a delivery of event carries. The same code builds both, so a sample's fields match a live delivery's key for key. Nothing is sent or recorded.

Use it to show real data while someone sets up an automation, before any event has fired — for a Zapier REST Hook trigger it is the Perform List request. Newest first, 3 unless you pass limit; an empty list means the organisation has no such records yet.

Supported events: contact.created, message.received, lead.created, call.missed, flow.response_received.

Security:

  • The organisationId in the URL must match the organisation your JWT was issued for — requests for a different organisation fail with 401.
  • Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role; other roles receive 403.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your organisation UUID (returned as org from the /token endpoint).

Query Params
string
enum
required

The event to show samples of.

Allowed:
number
Defaults to 3

How many samples to return (1–10).

Responses

400

Bad request — an unsupported event, or a limit outside 1–10

401

Unauthorized — invalid/expired JWT or organisation ID does not match the token

403

Forbidden — role not permitted

429

Too many requests

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json