Site Events Tools

Tools for a site’s event log and catalog — what a site can react to.

5 tools

Available Tools

events_catalog

List the events a site can react to: built-in and custom, with counts

Input Schema

projectId

stringrequired

Site (project) id

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "events_catalog",
    "arguments": {
          "projectId": "example"
    }
  }
}

events_describe

Set or clear the description of an event in the catalog

Input Schema

`projectId`	stringrequired
`name`	stringrequired
`description`	stringrequired

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "events_describe",
    "arguments": {
          "projectId": "example",
          "name": "example",
          "description": "example"
    }
  }
}

events_getSettings

Read which events a site records

Input Schema

projectId stringrequired

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "events_getSettings",
    "arguments": {
          "projectId": "example"
    }
  }
}

events_updateSettings

Change which events a site records (merges with what is stored)

Input Schema

`projectId`	stringrequired
`settings`	objectrequired

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "events_updateSettings",
    "arguments": {
          "projectId": "example",
          "settings": {}
    }
  }
}

events_emit

Emit a custom event for a site (owner or agent), e.g. cart_abandoned with properties

Input Schema

`projectId`	stringrequired
`name`	stringrequired
`subjectId`	string
`properties`	object
`idempotencyKey`	string

Example Call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "events_emit",
    "arguments": {
          "projectId": "example",
          "name": "example",
          "subjectId": "example"
    }
  }
}