Send your first structured event

This walkthrough sends one synthetic API outcome to Telemetry. Check the 200 response, then verify that the event has fields you can use in SQL, dashboards, alerts, and debugging. Keep raw request payloads out of the event.

Before you start

Already copied the setup prompt from the homepage? Use its anon_… API key below. You can send events and query them without creating an account.

If you have an account, create a read-and-write key in Team Settings → API Keys for this walkthrough, since the next step reads the event back. An application that only sends events can use a write key.

Keep your key in a local environment variable or secret manager:

export TELEMETRY_API_KEY="replace-with-your-key"

Do not expose a team key in browser JavaScript, a mobile application, a public repository, or a screenshot. See API Keys and Authentication for scope and rotation guidance.

Choose one completed workflow

Start at a boundary where the application knows the outcome. Good first events include:

• api_request_completed
• background_job_completed
• webhook_processing_completed
• checkout_completed
• agent_run_completed

Prefer a completed outcome over a generic message such as something_happened. A stable event name gives every producer and query the same grain.

For this example, use a synthetic API request:

{
  "route_template": "/api/reports/:report_id",
  "method": "POST",
  "status": "success",
  "status_code": 200,
  "latency_ms": 184,
  "release": "local-demo",
  "environment": "development",
  "request_id": "req_demo_001"
}

The URL is a route template rather than a raw URL containing identifiers. The event includes categorized outcome fields and a safe correlation identifier, but no request body, authorization header, cookie, or customer content.

Send the event with cURL

curl https://api.telemetry.sh/log \
  -H "Authorization: Bearer $TELEMETRY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "table": "api_request_completed",
    "data": {
      "route_template": "/api/reports/:report_id",
      "method": "POST",
      "status": "success",
      "status_code": 200,
      "latency_ms": 184,
      "release": "local-demo",
      "environment": "development",
      "request_id": "req_demo_001"
    }
  }'

Use the exact request shape documented by the Log API if your SDK or API version differs from this example.

Send the same event from JavaScript

import telemetry from "telemetry-sh";

telemetry.init(process.env.TELEMETRY_API_KEY);

await telemetry.log("api_request_completed", {
  route_template: "/api/reports/:report_id",
  method: "POST",
  status: "success",
  status_code: 200,
  latency_ms: 184,
  release: "local-demo",
  environment: "development",
  request_id: "req_demo_001"
});

Initialize the SDK in trusted server-side code. Keep field names and units consistent across services. For example, store duration in latency_ms and always use milliseconds.

What success means

Anonymous queries are available for 24 hours after your first event. Create an account within 7 days to keep your events and the same key. Signup detects the trial in this browser; in another browser, choose Already have an anonymous API key? and paste your key before registering. Existing users can use Keep my data, then log in. Trials with no events expire 7 days after creation.

A successful send proves only that the API accepted the event. Continue with Verify Event Ingestion to check the table name, inferred types, generated timestamp, and exact row. Do not instrument more workflows until the first event contract is queryable and safe.

For a larger schema, read Designing an Event Schema. For sensitive fields, use Redacting Sensitive Data.