Skip to content

tecmie/followup-sdk

Repository files navigation

Followup Node SDK

And SDK to interact with the Followup API

✨ Features

  • 🌈 Trigger new notifications from node
  • 📦 Easy to setup and integrate
  • 🛡 Written in TypeScript with predictable static types.

📦 Install

npm install @followup/node
yarn add @followup/node

🔨 Usage

import { Followup } from '@followup/node';

const followup = new Followup(process.env.FOLLOWUP_API_KEY);

await followup.trigger('<REPLACE_WITH_EVENT_NAME>', {
  $user_id: "<USER IDENTIFIER>",
  $email: "<USER_EMAIL>",
  customAttribute: "", // use the custom attribute from each event here
  firstName: "" 
});

TypeScript

@followup/node is written in TypeScript with complete definitions.

🔗 Links