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

Send Your First Event

Operational receives events at POST /api/v1/log.

Use the API key from the project you want to track.

SDK example:

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

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

await ops.events.log({
  name: "user signed up",
  avatar: "🎉",
  content: "Signup from pricing page",
});

Direct HTTP example:

const event = {
  name: "user signed up",
  avatar: "🎉",
  content: "Signup from pricing page",
};

await fetch("https://api.operational.co/api/v1/log", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.OPERATIONAL_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(event),
});

A successful request returns 201 with success.

Get startedStructured Events

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