Node.js SDK upgrade (v0.x to v1.0)

Import the SDK using the standard ES6 import syntax:

Initialize your client with an options object:

The v1.0 SDK brings complete TypeScript support, improved error handling, and new resources to the Node.js ecosystem.

Complete TypeScript definitions for all requests and responses:

Typed errors with better context:

Iterate through paginated resources automatically:

Get more control over raw responses:

Better debugging capabilities:

Fine-tune request behavior:

Additional resources like Audiences, Channels, and Integrations:

Client initialization accepts an options object instead of just the API key.

Some parameter names have changed to match the API (e.g., cancellationKey is now cancellation_key).

Error handling has been completely revamped with typed errors.

The signUserToken method should now be imported from @knocklabs/node/lib/tokenSigner if referenced directly:

Several method names have changed:

• notify() is now workflows.trigger()
• users.getSchedules() is now users.listSchedules()
• workflows.createSchedules() is now schedules.create()
• workflows.listSchedules() is now schedules.list()
• workflows.updateSchedules() is now schedules.update()
• workflows.deleteSchedules() is now schedules.delete()

Bulk operations are now organized in their own namespaces: users.bulk.*, objects.bulk.*, schedules.bulk.*, etc.

A PreferenceSet ID parameter is now required for users.getPreferences().

All parameters are now in camelCase in the method signature but use snake_case in the request body. Query parameters are now passed as a separate object in most list methods:

The new SDK returns the data directly in most cases rather than wrapped in a data property. Pagination is handled differently with cursor-based pagination.

If you run into any issues during your migration, reach out to our support team or open an issue on GitHub.