Operational

DocsGithub Open app

Operational

Github Articles Pitch Usecases Playground API

Contents

Start here
Setup
Get started Send your first event Structured Events Actions Contexts Log limits and errors
Events API
API
Error handling Event parametersPOST Log event Sending actions in events
The Manual
Introduction PWA & push notifications Conventions Setup Manage projects and teammates Categories and search View events in your project Setup PWA on phone Test mode Notifications
Integrations
Nodejs SDK PHP SDK Wordpress plugin
Self hosting
Introduction Install locally Install on VPS Install on Render Install via Docker Install via Docker and Coolify Onboarding Setup .env Setup PWA & push notifications Best practices Durability testing
Other
Vision Roadmap Contributing

Get started

Operational helps you track important server events in one place so you can debug issues faster, monitor workflows, and keep your team informed.

Create your Operational account

Sign up at operational.co. After signup, Operational will take you through onboarding.

Create your first project

During onboarding, create your first project. Your events, teammates, and settings are scoped to this project.

A common setup is:

  1. One project for production.
  2. One project for staging.

Get your API key

After creating a project, copy the API key shown in your dashboard. Store it in your server environment variables:

process.env.OPERATIONAL_API_KEY

Send your first event

You can send your first event from any server code path where something important happens.

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

const ops = new Operational(process.env.OPERATIONAL_API_KEY);

await ops.events.log({
  name: "user signed up",
  avatar: "✅",
  category: "auth",
  content: "New signup from website form",
});

Operational then stores this event in your project timeline so you can search, inspect, and act on it.

What to do next

  1. Continue to Send your first event for request formats.
  2. Review Structured events for richer payloads.
  3. Set up PWA notifications to get real-time alerts.
Send your first event

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