Skip to main content
This is the official TypeScript/Node.js SDK for the Siren notification platform.

Installation

Basic Usage

SDK Methods

The Siren TypeScript SDK provides a clean, namespaced interface to interact with the Siren API. Below are the available methods organized by functionality.

Templates

Channel Templates

Messaging

Workflows

Webhooks

Users

For Package Developers

Environment Configuration

For testing the SDK, set these environment variables:
  • SIREN_API_KEY: Your API key from the Siren dashboard
  • SIREN_ENV: Set to dev for development/testing (defaults to prod)

Prerequisites

  • Git
  • Node.js 14 or higher
  • npm or yarn

Setup Steps

1

Clone the repository

2

Install dependencies

3

Set up pre-commit hooks

You are now ready to contribute to the @trysiren/node SDK!

Code Style & Linting

Code style is enforced by:
  • ESLint and Prettier for code formatting
  • TypeScript compiler for type checking
These tools are automatically run via pre-commit hooks.

Running Tests

To run the test suite, use the following command from the project root directory:
This will execute all tests defined in the src/__tests__/ directory.

Submitting Changes

  1. Create a feature branch for your changes
  2. Commit your changes (pre-commit hooks will run)
  3. Push your branch and open a Pull Request against the develop branch