Operational

DocsGithub Open app

Operational

Github Articles Pitch Usecases Playground API

Contents

Start hereSetup Operational
Guided setup
IntroductionCreate project and API keyManage projects and teammatesSend your first eventStructured eventsAdd actionsGroup events with contextsCategories and searchView events in your projectSetup PWA on phoneLog limits and errors
The Manual
IntroductionPWA & push notificationsConventionsSetupTest modeNotifications
Integrations
Nodejs SDKPHP SDKWordpress plugin
Events API
IntroductionSend your first eventEvent parametersStructured EventsActionsContextsCategoriesError handling
Self hosting
IntroductionInstall locallyInstall on VPSInstall on RenderInstall via DockerInstall via Docker and CoolifyOnboardingSetup .envSetup PWA & push notificationsBest practicesDurability testing
Other
VisionRoadmapContributing

Structured events

You can choose how an event is displayed with the type field.

Text (default)

const e = {
  name: "user upgraded",
  avatar: "💳",
  content: "Moved from Starter to Pro",
};

JSON

const e = {
  name: "new lead metadata",
  avatar: "🧩",
  type: "json",
  content: {
    source: "landing-page",
    utmCampaign: "launch-2026",
    score: 81,
  },
};

Image

const e = {
  name: "receipt captured",
  avatar: "🧾",
  type: "image",
  content: "https://images.unsplash.com/photo-1554224155-8d04cb21cd6c?w=1000",
};

Rows

const e = {
  name: "payment failed",
  avatar: "⚠️",
  type: "rows",
  content: [
    { label: "User ID", content: "usr_123" },
    { label: "Plan", content: "Pro" },
    { label: "Amount", content: "$49.00" },
    {
      label: "Gateway response",
      type: "json",
      content: { code: "card_declined", retryable: true },
    },
  ],
};

Notes:

  1. If you do not pass type, Operational uses text.
  2. Do not put rows inside rows.
Send your first eventAdd actions

Operational

PrivacyTerms
About the product
  • Use cases
  • Playground
  • API
  • Pitch
  • Pricing
  • Wordpress plugin
Related to the product
  • Open Source
  • Articles
  • VS Logsnag
Useful articles for your SaaS
  • My experience running a Commercial OSS project
  • Force post: The Payment Hack that lets Merchants charge you without approval
  • 6 Best practices for early stage B2B SaaS customer support
  • Setup event notifications for your SaaS