API Reference

Getting Started

Notifyr allows you to manually and programatically send notifications to your customers through their dashboard.

React is the only framework currently supported.

To learn more about Notifyr, check out the home page! https://notifyr.vercel.app/

Technical Overview

You can implement the <NotificationMenu /> SDK component into your customer's dashboard allowing them to view their notifications. To send notifications, you can do so programatically through the provided Notifyr class in the SDK or manually through the dashboard.

Setting Up

Follow these steps to add Notifyr to your app.

  1. Install the Notifyr SDK npm i @notifyr/sdk or yarn add @notifyr/sdk
  2. Go to the dashboard to claim your API key

Products

Notifyr provides a few products:

  1. Dashboard: You can find your API key, send notifications manually, and view sent notifications.
  2. SDK: The SDK provides a component to render notifications and an object to send notifications.
  3. API: The API is used to create a session secret used in the SDK.