Record custom events from your server (shape-only: a name, a time, IDs and tags)

View as Markdown

POST /api/v1/events · operationId recordCustomEvents

For developers: your server sends this request with a server key; it is not a button in the dashboard.

Counted per day, per account and month; never a message, parameters or payload: unknown fields are refused. A resent eventId is a replay. See Custom events, tags and debug mode.

Authentication

Send Authorization: Bearer YOUR_SERVER_KEY (siteServerKey: Site server key in Authorization: Bearer <key> (the scheme is case-insensitive and required; a bare key is 401). Shown once on creation or rotation. Publishable keys cannot authenticate). Keep the server key in server-only configuration; never send it to a browser.

Request body

Content-Type: application/json (required)

JSON
{
  "events": [
    {
      "eventId": "event_00000001",
      "name": "report_exported",
      "at": 1762300800000,
      "accountId": "acct_456",
      "userId": "usr_123",
      "tags": {
        "format": "csv"
      }
    }
  ]
}

Responses

Success body fields

Failures are not verdicts. Error bodies follow the Error schema: code is one of bad_request, unauthorized, session_reinit_required, forbidden, not_found, conflict, identity_required, payload_too_large, rate_limited, internal_error, service_unavailable, request_failed, approval_invalid, approval_used, approval_expired, approval_mismatch, step_up_not_held, step_up_mismatch, step_up_settled, step_up_expired, step_up_superseded, agent_tokens_disabled, tool_not_approved, tool_not_read_only. Errors and retries explains each code and what to do.

Example

curl
curl -sS -X POST 'https://app.trytelltale.dev/api/v1/events' \
  -H "Authorization: Bearer $TELLTALE_SERVER_KEY" \
  -H 'Content-Type: application/json' \
  --data '{"events":[{"eventId":"event_00000001","name":"report_exported","at":1762300800000,"accountId":"acct_456","userId":"usr_123","tags":{"format":"csv"}}]}'
fetch
const response = await fetch("https://app.trytelltale.dev/api/v1/events", {
  method: "POST",
  headers: {
    Authorization: 'Bearer ' + process.env.TELLTALE_SERVER_KEY,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "events": [
      {
        "eventId": "event_00000001",
        "name": "report_exported",
        "at": 1762300800000,
        "accountId": "acct_456",
        "userId": "usr_123",
        "tags": {
          "format": "csv"
        }
      }
    ]
  }),
  signal: AbortSignal.timeout(5000)
});
const result = await response.json();

Machine-readable contract: openapi.json. Request builder: the API explorer shows every operation as curl; it sends requests only on a local dashboard.