Operational

DocsGithub Open app

Operational

Github Articles Pitch Usecases Playground API

Contents

Start hereSetup Operational
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 practices
Other
VisionRoadmapContributing

Nodejs SDK

Installation

Use npm to install Operational’s nodejs SDK. Run this inside your project:

npm install --save @operational.co/sdk

Authorization

Pass your api key like this:

import Operational from "@operational.co/sdk"
// Or use this if you're on a older version of nodejs
// const Operational = require('@operational.co/sdk')

const apikey = ''; // <-- Enter your api key here

const ops = new Operational(apikey);

Code examples

Visit the Playground and select Nodejs SDK as the code language to generate code examples.

For self hosters

Pass your backend’s url when initiating the Operational class.

const ops = new Operational(apikey, {
  baseUrl : 'https://xzy.abc.com' // <- Enter your backend's url here.
})

You can find this url inside your self hosted instance’s profile page under your api key.

PHP SDK

Operational

Event tracker for your product.

PrivacyTerms
About the product
  • Use cases
  • Playground
  • API
  • Pitch
  • Wordpress plugin
  • Bubble plugin
Related to the product
  • VS Logsnag
  • Open Source
  • Articles
Useful articles for your business
  • 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
  • How to get high quality users for your B2B SaaS business?