# @notifire/node

> A nodejs package for interacting with the notifire api

Latest version **1.0.5** (published 2021-08-19) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2021-08-19 |
| First published | 2021-05-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 1 |
| Unpacked size | 21.4 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | scopsy |

## Links

- npm: https://www.npmjs.com/package/@notifire/node
- Repository: https://github.com/notifirehq/node
- Homepage: https://github.com/notifirehq/node#readme
- Issues: https://github.com/notifirehq/node/issues
- npm.io page: https://npm.io/package/@notifire/node

## Dependencies (1)

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

## Recent versions

- 1.0.5 (latest) — 2021-08-19
- 1.0.4 — 2021-05-13
- 1.0.3 — 2021-05-13

## README

<p align="center">
  <a href="https://notifire.co">
    <img width="200" src="https://notifire.co/img/logo.png">
  </a>
</p>

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

<div align="center">

And SDK to interact with the Notifire API

</div>

## ✨ Features

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

## 📦 Install

```bash
npm install @notifire/node
```

```bash
yarn add @notifire/node
```

## 🔨 Usage

```ts
import { Notifire } from '@notifire/node';

const notifire = new Notifire(process.env.NOTIFIRE_API_KEY);

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

```

### TypeScript

`@notifire/node` is written in TypeScript with complete definitions.

## 🔗 Links

- [Home page](https://notifire.co/)

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