Sign in
Docs
0%

Events and webhooks

Events tools for assistants (MCP)

The 2 tools an assistant can call for Events over MCP: what each one does, the scopes it needs, its arguments and an example call.

The catalogue of every event the account can receive, a live stream of them as they happen, counts per day, and the account's notifications. Read the catalogue to know what a webhook will carry, and stream events when you want them without running a server. An assistant calls these tools over MCP; the same operations over HTTP are in the Events API. Tools for assistants lists every product, and MCP shows how to connect an assistant.

events_list_event_types

List event types. The event catalogue: every type, what it means and its JSON Schema.

Scopes: mcp:read, events:read · reads only

ArgumentTypeWhat it is
page_sizeintegerAt most 200 (larger is coerced down); 0 means 50.
page_tokenstringFrom the previous answer's next_page_token; "" for the first page.
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "events_list_event_types",
    "arguments": {
      "page_size": 20
    }
  }
}

events_get_event_stats

Get event stats. The account's webhook endpoints. Published events per UTC day and type over the last 7 or 30 days (what happened on the account, whether or not an endpoint took it).

Scopes: mcp:read, events:read · reads only

ArgumentTypeWhat it is
account_idstringThe account; empty is the caller's own.
rangestring"7d" or "30d" (the default).
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "events_get_event_stats",
    "arguments": {
      "range": "7d"
    }
  }
}