Notiflows provides SDKs to help you integrate notifications into your application. There are two types of SDKs:

Server-side SDKs - Trigger notiflows and manage users from your backend
Client-side SDKs - Display notifications and manage preferences in your frontend

Server-side SDKs

Server-side SDKs authenticate using your Secret API Key and are used to:

Trigger notiflows to send notifications
Create and manage users
Manage topic subscriptions
Query notifications and delivery status

Node.js

Official SDK for Node.js applications

Python

Official SDK for Python applications

Ruby

Official SDK for Ruby applications

Go

Official SDK for Go applications

PHP

Official SDK for PHP applications

Java

Official SDK for Java applications

.NET

Official SDK for .NET applications

Client-side SDKs

Client-side SDKs authenticate using a User Key (generated per-user) and are used to:

Display in-app notification feeds
Mark notifications as read, seen, or archived
Manage user notification preferences
Subscribe to real-time notification updates

JavaScript

Core client for any JavaScript application

React

React components and hooks for notification UI

Swift

Native SDK for iOS, iPadOS, macOS, and watchOS (coming soon)

Kotlin

Native SDK for Android (coming soon)

Authentication

Server-side Authentication

Server-side SDKs use your project's Secret API Key for authentication. You can find this in your project settings under API Keys.

import { Notiflows } from '@notiflows/node';

const client = new Notiflows(process.env.NOTIFLOWS_SECRET_KEY);

Never expose your Secret API Key in client-side code. It should only be used in your backend.

Client-side Authentication

Client-side SDKs require a User Key that you generate on your backend for each authenticated user. This ensures users can only access their own notifications.

See Generating User Tokens for detailed instructions on how to generate user keys from your backend.

API Reference

All SDKs interact with the Notiflows API. For detailed endpoint documentation, see:

Admin API Reference - Server-to-server API
User API Reference - Client-side API

Overview