# @followup/node

> A nodejs package for interacting with the followup api

Latest version **1.0.12** (published 2022-02-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @followup/node
pnpm add @followup/node
yarn add @followup/node
bun add @followup/node
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.12 |
| Published | 2022-02-15 |
| First published | 2022-02-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 1 |
| Unpacked size | 567.9 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | peoray, koolamusic |

## Links

- npm: https://www.npmjs.com/package/@followup/node
- Repository: https://github.com/tecmie/followup-sdk
- npm.io page: https://npm.io/package/@followup/node

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.21.1

## Recent versions

- 1.0.12 (latest) — 2022-02-15
- 1.0.11 — 2022-02-15
- 1.0.10 — 2022-02-15

## README

<h1 align="center">Followup Node SDK</h1>

<div align="center">

And SDK to interact with the Followup API

</div>

## ✨ Features

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

## 📦 Install

```bash
npm install @followup/node
```

```bash
yarn add @followup/node
```

## 🔨 Usage

```ts
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

- [Home page](https://followup.so/)

---
_Source: https://npm.io/package/@followup/node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._