Skip to main content

Introduction

Welcome to the Conviso Node.js SDK documentation! This library provides a simple and powerful way to integrate your Node.js application with Codematic's Customer Data Platform.

What is the Node.js SDK?​

The Conviso Node.js SDK is a TypeScript-first library that allows you to:

  • 🎯 Identify users and track their attributes
  • 📊 Track events to understand user behavior
  • 📧 Send transactional emails (template-based or raw HTML)
  • 📱 Send push notifications to your users
  • 🔄 Dual-write for migration scenarios
  • ⚡ Handle high throughput with built-in concurrency limiting
  • 🛡️ Type-safe with full TypeScript support

Key Features​

Simple API​

The SDK provides an intuitive API that makes it easy to get started:

import { CDPClient } from '@codematic.io/cdp-node';

const client = new CDPClient({
  cdpApiKey: 'your-api-key'
});

await client.identify('user123', {
  email: '[email protected]',
  firstName: 'John',
  lastName: 'Doe'
});

await client.track('user123', 'purchase_completed', {
  amount: 99.99
});

Production-Ready​

  • Connection pooling for optimal performance
  • Automatic concurrency limiting to prevent overwhelming your infrastructure
  • Comprehensive error handling with detailed error messages
  • Dual-write support for seamless migration from Customer.io

TypeScript Support​

Built with TypeScript from the ground up, providing excellent IDE support and type safety:

// Full type checking and autocomplete
const emailRequest: SendEmailRequestWithTemplate = {
  to: '[email protected]',
  identifiers: { id: 'user123' },
  transactional_message_id: 'WELCOME_EMAIL',
  message_data: { name: 'John' }
};

Getting Started​

Ready to integrate the Conviso Node.js SDK? Head over to the Installation Guide to get started!

Resources​