SDKs and client libraries

Official Client SDKs

To make integration easier and more efficient, we provide official SDKs in TypeScript and Java. These libraries simplify API interactions by handling request formatting, authentication, and error handling for you, allowing you to focus on your application rather than managing API communication. The TypeScript SDK includes:

Simple setup and configuration
Type-safe methods for all available API endpoints
Built-in retry logic for transient failures
Automatic error handling with clear exception messages

TypeScript

The TypeScript SDK is perfect for web applications or backend services built with Node.js, Bun and more, offering a streamlined and robust integration experience.

Default usage

import Nuntly from '@nuntly/sdk';

const client = new Nuntly({
  apiKey: process.env['NUNTLY_API_KEY'],
});

async function sendEmail() {
  const email = await client.emails.send({
    from: 'ray@info.tomlinson.ai',
    to: 'brian67@gmail.com',
    subject: 'Verify Your Email Address',
    text: 'Thank you for signing up! Please verify your email address...',
  });

  console.log(email.id);
}

sendEmail();

Use async/await without all the try catch blocks

const client = createSafeNuntly({ apiKey: NUNTLY_API_KEY });

async function sendEmail() {
  const { data, error } = await client.emails.send({
    from: 'ray@info.tomlinson.ai',
    to: 'brian67@gmail.com',
    subject: 'Verify Your Email Address',
    text: 'Thank you for signing up! Please verify your email address...',
  });

  if (error) {
    console.log(error.status); // 400
    console.log(error.details);
    // ...
  }

  console.log(data.id);
}

sendEmail();

Framework guides

Step-by-step guides that send an email and handle its webhook events with the official SDKs:

Send email from Next.js with a Server Action and a Route Handler
Send email from Express with an Express route
Send email from NestJS with the client registered as a provider
Send email from Spring Boot with the Spring Boot starter

Community SDKs

These SDKs are built and maintained by the community, not by Nuntly.

Language	Repository
Elixir	mindreframer/nuntly

API Reference

Agents

API Keys

Broadcasts

Templates

Segments

Topics

Contacts

Domains

Emails

Inboxes

Threads

Messages

Namespaces

Organizations

Contact Properties

Segment memberships

Topic memberships

Webhooks

Webhooks Events

Webhooks Hook

SDKs and client libraries

Official Client SDKs

TypeScript

Default usage

Use async/await without all the try catch blocks

Framework guides

Community SDKs

​Official Client SDKs

​TypeScript

​Default usage

​Use async/await without all the try catch blocks

​Framework guides

​Community SDKs

Official Client SDKs

TypeScript

Default usage

Use async/await without all the try catch blocks

Framework guides

Community SDKs