GET/v1/webhooks/event-types/{event_type}/samplebeta

Get a sample payload

Needs: Read your data (mcp:read)
Plan: Any plan with API access
Limits: 300 a minute per key
Undo: Nothing to undo: this only reads.

Returns an example of exactly what your endpoint receives for one event type. Build your receiver against it.

Try it

Path

event_typerequiredstring

The event type id.

Query (1)

versionoptionalstring

Payload version. Default: the latest.

This only reads. It uses your real data and changes nothing.

curl -X GET 'https://mcp.wa-api.cloud/v1/webhooks/event-types/contact.created/sample' \
  -H "Authorization: Bearer $API_KEY"

The code reads your key from $API_KEY.

Parameters

Parameters
Field	Type	What it is
event_typerequired	string · path	The event type id.pattern `^[a-z0-9._-]+(\/[A-Za-z0-9._-]+)?$` · 3–120 charactersSigned in? Pick one from your data with “My data”.
version	string · query	Payload version. Default: the latest.pattern `^[A-Za-z0-9._-]+$` · 0–20 characters

Headers

Headers
Field	Type	What it is
Authorizationrequired	header	`Bearer $API_KEY` — your API key.
Api-Version	header	The API version to use, e.g. `2026-10-01`. Default: the version your key is pinned to.one of: `2026-10-01` · pattern `^\d{4}-\d{2}-\d{2}$`

Response `200`

The sample.

Response fields
Field	Type	What it is
event_type_idrequired	string
display_namerequired	string
descriptionrequired	string or null
samplerequired	any
emptyrequired	boolean
note	string

Errors

Errors are application/problem+json. Branch on code.

Status	Code	When
400	invalid_input	A field is missing or has the wrong format. `errors[]` points at each field.
401	unauthenticated	The Authorization header is missing, the key is unknown, expired or revoked.
403	entitlement_required	The workspace's plan does not include API access (`api_access`).
403	insufficient_scope	The key does not have the permission this operation needs.
404	not_found	No active event type with this name.
429	rate_limited	The key or workspace went over its rate limit. Wait for `Retry-After` seconds.
503	upstream_unavailable	A service behind the API is briefly unavailable. Safe to retry with backoff.

Examples

contact.created

Response 200

{
  "event_type_id": "contact.created/1",
  "display_name": "Contact created",
  "description": "A new contact was added.",
  "sample": {
    "id": "evt_01J8Z7BZQ4F6G8J2K5N7Q9S1VC",
    "type": "contact.created",
    "api_version": "2026-10-01",
    "occurred_at": "2026-09-23T03:02:10Z",
    "company_id": 1001,
    "data": {
      "id": 48213,
      "company_id": 1001,
      "name": "Jane Doe",
      "phone_number": "15555550123",
      "source": "api"
    }
  },
  "empty": false
}

Operation path

The same operation is also at POST /v1/ops/webhooks_get_event_sample, with every field in the JSON body.