WorkOS Node Library

The WorkOS Node.js library provides convenient access to the WorkOS API from JavaScript/TypeScript.

Documentation

API reference documentation is available here.

Installation

npm install --save workos
# or
yarn add workos

In Deno (1.25+) you can import by doing:

import { WorkOS } from "npm:workos";

Usage

import { WorkOSClient, WorkOS } from 'workos';

const workos = new WorkOSClient({
  authorizationToken: "...", // Defaults to process.env.WORKOS_API_KEY
});

const organization = workos.organizations.create({
  name: "Foo Corp",
  domains: "foo-corp.com",
});

Request and Response Types

The SDK exports all request and response types as TypeScript interfaces. Simply import them under the WorkOS namespace:

import { WorkOS } from "workos"; 

const user: WorkOS.User = {
  id: "...",
  user: "Foo user",
  email: "[email protected]"
}

Automatic Pagination

List endpoints are paginated. The SDK provides an iterator so that you can simply loop over the items:

import { WorkOSClient } from 'workos';

const page = workos.organizations.list();
for await (const organization of page) {
  console.log("Received organization", organization);
}

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of WorkOSError will be thrown:

import { WorkOSError } from 'workos';

try {
  await works.directoryGroups.get(...);
} catch (err) {
  if (err instanceof WorkOSError) {
    console.log(err.statusCode); 
    console.log(err.message);
    console.log(err.body); 
  }
}

Retries

The WorkOS Node SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retriable when any of the following HTTP status codes is returned:

• 408 (Timeout)
• 409 (Conflict)
• 429 (Too Many Requests)
• 5XX (Internal Server Errors)

Use the maxRetries request option to configure this behavior.

const response = workos.directoryGroups.get("e7525084....fd94153226fb781", {
  maxRetries: 0 // override maxRetries at the request level
});

Timeouts

The SDK defaults to a 60 second timout. Use the timeoutInSeconds option to configure this behavior.

const response = workos.directoryGroups.get("e7525084....fd94153226fb781", {
  timeoutInSeconds: 30 // override timeout to 30s
});

Idempotency Headers

Idempotent endpoints, such as the endpoint used to create an audit log event, include a special RequestOption that can be used to set the Idempotency-Key header like so:

import { WorkOSClient } from 'workos';

await client.auditLogs.createEvent({
  OrganizationID: "2dafd4e4-0932-4873-9fcf-16fbf1cf3fbd"
}, {
  idempotencyKey: "64099353-b48b-4dcd-98b7-74df1cc57933"
});

Runtime compatiblity

The SDK defaults to node-fetch but will use the global fetch client if present. The SDK works in the following runtimes:

The following runtimes are supported:

• Node.js 18+
• Vercel
• Cloudflare Workers
• Deno v1.25+
• Bun 1.0+

Customizing Fetch client

The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an unsupported environment, this provides a way for you to break the glass and ensure the SDK works.

import { WorkOSClient } from 'workos';

const workos = new WorkOSClient({
  authorizationToken: "...",
  fetcher: // provide your implementation here
});

Beta status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your package.json file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is.

We suggest opening an issue first to discuss with us!