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

Create project and API key

After signup, onboarding asks you to create your first project. You also get a project API key.

A good setup for most teams:

  1. One project for production.
  2. One project for staging.
  3. Store API keys in environment variables.
  4. Invite teammates only to projects they need.

Initialize the SDK in your backend:

import Operational from "@operational.co/sdk";

const ops = new Operational(process.env.OPERATIONAL_API_KEY, {
  // Optional for self-hosted or custom domains
  // baseUrl: "https://api.your-domain.com",
});
IntroductionManage projects and teammates

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