Skip to content
API PlatformDevelopers
GET/v1/webhooks/event-typesstable

List event types

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.

The catalog of events an endpoint can subscribe to, such as contact.created/1. Each page of this portal under Events shows one with its payload.

Try it

Query (5)

contacts, conversations, messages, broadcasts, sla or taxonomy.

Name contains.

Hide retired types.

How many items per page (1–100).

The `next_cursor` from the previous page. Cursors expire after 24 hours.

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

Code and response

curl -X GET 'https://mcp.wa-api.cloud/v1/webhooks/event-types?category=contacts' \
  -H "Authorization: Bearer $API_KEY"

The code reads your key from $API_KEY.

Parameters

Parameters
FieldTypeWhat it is
categorystring · querycontacts, conversations, messages, broadcasts, sla or taxonomy.1–64 characters
searchstring · queryName contains.1–100 characters
active_onlyboolean · queryHide retired types.default true
limitinteger · queryHow many items per page (1–100).1–100 · default 25
cursorstring · queryThe next_cursor from the previous page. Cursors expire after 24 hours.1–2048 characters

Headers

Headers
FieldTypeWhat it is
AuthorizationrequiredheaderBearer $API_KEY — your API key.
Api-VersionheaderThe 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

A page of event types.

Response fields
FieldTypeWhat it is
datarequiredarray of object
idrequiredstringSubscribe with this id: "<type_name>/<version>".
type_namerequiredstring
versionrequiredstring
categoryrequiredstring
display_namerequiredstring
descriptionrequiredstring or null
activerequiredboolean
totalrequirednumber
categoriesarray of object
slugrequiredstring
display_namerequiredstring
descriptionrequiredstring or null
next_cursorrequiredstring or nullPass as "cursor" to get the next page; null when there are no more results.

Errors

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

StatusCodeWhen
400invalid_input

A field is missing or has the wrong format. errors[] points at each field.

401unauthenticated

The Authorization header is missing, the key is unknown, expired or revoked.

403entitlement_required

The workspace's plan does not include API access (api_access).

403insufficient_scope

The key does not have the permission this operation needs.

429rate_limited

The key or workspace went over its rate limit. Wait for Retry-After seconds.

503upstream_unavailable

A service behind the API is briefly unavailable. Safe to retry with backoff.

Examples

Contact events

Response 200

{
  "data": [
    {
      "id": "contact.created/1",
      "type_name": "contact.created",
      "version": "1",
      "category": "contacts",
      "display_name": "Contact created",
      "description": "A new contact was added.",
      "active": true
    }
  ],
  "next_cursor": null,
  "total": 1
}

Operation path

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