Home Articles Pitch Api

Contents

Start hereAPI DocsIntroductionSend your first eventEvent parametersStructured EventsActionsContextsError handlingManualIntroductionBasicsConventionsSetupTest modeNotificationsPWA

API Docs

Integrations

Operational has a official node.js SDK.

For other languages, you can use our REST Api.

To get started with our sdk, run this inside your project:

npm install --save @operational.co/sdk
Copy

Authentication

You will need a valid api key to use Operational.

To do so, create an account at app.operational.co

Then copy the api key from app.operational.co/profile/apikeys and pass it as the first parameter in the SDK or as a bearer token if using the REST api.

Example:

import Operational from "@operational.co/sdk";
// Or use this if imports are not supported in your node.js version
// const Operational = require("@operational.co/sdk");

const ops = new Operational("yourapikey");
Copy

Table of contents

  1. Send your first event
  2. Event parameters
  3. Structured events
  4. Actions
  5. Contexts
  6. Error handling
Send your first event