GET/v1/webhooks/endpoints/{endpoint_id}beta

Get an endpoint

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 one endpoint with every subscription, its status and failure count.

Try it

Path

endpoint_idrequiredstring

The endpoint id.

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

curl -X GET 'https://mcp.wa-api.cloud/v1/webhooks/endpoints/ep_01J8Z6Q4M9W2X7K3B5N1R0T8YA' \
  -H "Authorization: Bearer $API_KEY"

The code reads your key from $API_KEY.

Parameters

Parameters
Field	Type	What it is
endpoint_idrequired	string · path	The endpoint id.pattern `^ep_[0-9A-HJKMNP-TV-Z]{26}$`Signed in? Pick one from your data with “My data”.

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 endpoint.

Response fields
Field	Type	What it is
endpointrequired	object
idrequired	string
urlrequired	string
descriptionrequired	string or null
statusrequired	string	active \| disabled \| paused
custom_headersrequired	object	Custom header names; values masked to the last 4 characters.
consecutive_failuresrequired	number
disabled_atrequired	string or null
disabled_reasonrequired	string or null
signing_secretrequired	string	Always masked. The secret is shown once, on create or rotate.
payload_formatrequired	string	"data" = the event's data object as the body; "envelope" = {id, type, version, api_version, occurred_at, company_id, data}.one of: `data`, `envelope`
created_atrequired	string or null
updated_atrequired	string or null
subscriptions	object or null
countrequired	number
all_activerequired	boolean
event_typesrequired	array of object
subscriptionsrequired	array of object
idrequired	string
event_type_idrequired	string
event_type_namerequired	string
versionrequired	string or null
created_atrequired	string or null

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 endpoint with this id.
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

Read one endpoint

Response 200

{
  "endpoint": {
    "id": "ep_01J8Z6Q4M9W2X7K3B5N1R0T8YA",
    "url": "https://hooks.example.com/incoming",
    "description": "Order system",
    "status": "active",
    "custom_headers": {
      "X-Hook-Token": "••••9f2a"
    },
    "payload_format": "envelope",
    "consecutive_failures": 0,
    "disabled_reason": null,
    "signing_secret": "whsec_••••••••",
    "created_at": "2026-09-10T12:00:00Z",
    "updated_at": "2026-09-10T12:00:00Z",
    "disabled_at": null
  },
  "subscriptions": [
    {
      "id": "sub_01J8Z6Q5A1B2C3D4E5F6G7H8J9",
      "event_type_id": "contact.created/1",
      "event_type_name": "contact.created",
      "version": "1",
      "created_at": "2026-09-10T12:00:00Z"
    }
  ]
}

Operation path

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