Camunda 8 Unified SDK for Node.js

This SDK is deprecated and is not being maintained. With the release of Camunda 8.5 this is the Node.js SDK to use

This SDK provides a high-level Node.js API for Camunda Platform 8. It is a wrapper around the following individual clients:

• Web Console
• Optimize API Client
• Operate API Client
• Tasklist API Client
• Zeebe API Client
• Web Modeler API Client

It uses the following libraries to hydrate credentials from the environment:

• Camunda 8 Credentials from Environment
• Camunda SaaS OAuth

The full API documentation is hosted here.

Watch a seven-minute speedrun demo video here:

API Coverage

Component	Tested Environment
Zeebe	SaaS, Self-hosted
Operate	SaaS
Optimize	SaaS
Tasklist	SaaS
Console	SaaS

Installation

npm i camunda-8-sdk

Usage

Set your Camunda SaaS credentials in the environment (at the moment, only Camunda SaaS is fully supported).

import { C8 } from 'camunda-8-sdk'

const zbc = new C8.ZBClient()
const console = new C8.ConsoleApiClient()
const operate = new C8.OperateApiClient()
const optimize = new C8.OptimizeApiClient()
const tasklist = new C8.TasklistApiClient()

Refer to the API docs here for full documentation of each component.