Getting Started

Installation

Install the Unchange SDK using your preferred package manager:

npm install unchange-sdk

pnpm add unchange-sdk

yarn add unchange-sdk

bun add unchange-sdk

Initialize the SDK with your API key and project ID:

import { Unchange } from 'unchange-sdk';

const client = new Unchange({
  apiKey: 'your-api-key',
  projectId: 'your-project-id',
});

If you're using a self-hosted instance or a different environment, you can specify a custom base URL:

const client = new Unchange({
  apiKey: 'your-api-key',
  projectId: 'your-project-id',
  baseUrl: 'https://your-custom-domain.com',
});

Get all changelogs for your project:

const changelogs = await client.changelogs.list();
console.log(changelogs);

Retrieve the most recent changelog:

const latest = await client.changelogs.getLatest();
console.log(latest);

Create a new user to track their changelog interactions:

await client.users.create('user-123');

Mark a changelog as seen by a specific user:

await client.changelogs.acknowledge('changelog-id', 'user-123');