Docs

Node.js + Pushfire

Integrations

Overview

PushFire provides:

  • Easy device registration and management
  • Subscriber authentication and profiling
  • Tagging system for targeted notifications
  • Workflow automation for user engagement
  • Secure API communication
  • Cross-platform support (Browser, Node.js, React Native)

For more information, visit the PushFire website.

Installation

terminal

Quick Start

Client-side Usage

client.ts

Server-side Usage

server.ts

API Reference

Client

Initialization

  • createClient(config) – Creates a new client instance
  • client.init(fcmToken, options?) – Register device

Devices

  • client.devices.register(data) – Register new device
  • client.devices.update(data) – Update existing device

Subscribers

  • client.subscribers.login(data) – Log in a subscriber
  • client.subscribers.logout(data) – Log out a subscriber
  • client.subscribers.update(data) – Update subscriber info

Tags

  • client.subscriberTags.add(data) – Add a tag
  • client.subscriberTags.update(data) – Update a tag
  • client.subscriberTags.remove(data) – Remove a tag

Workflows

  • client.workflowExecutions.create(data) – Create a workflow execution

Server

Server instances provide direct resource access and context-aware methods:

Direct Resource Access

  • server.devices – Device operations
  • server.subscribers – Subscriber operations
  • server.subscriberTags – Tag operations
  • server.workflowExecutions – Workflow operations

Context-Aware Methods (using cookies)

  • server.extractContext(cookieHeader) – Extract device context
  • server.createCookieHeaders(data) – Create Set-Cookie headers

Device operations:

  • server.registerDeviceWithContext(data) – Register device, return cookies
  • server.updateDeviceFromContext(cookieHeader, data) – Update device

Subscriber operations:

  • server.loginSubscriberFromContext(cookieHeader, data) – Login subscriber, return cookies
  • server.logoutSubscriberFromContext(cookieHeader) – Logout subscriber
  • server.updateSubscriberFromContext(cookieHeader, data) – Update subscriber

Tag operations:

  • server.addTagFromContext(cookieHeader, tagId, value) – Add tag
  • server.updateTagFromContext(cookieHeader, tagId, value) – Update tag
  • server.removeTagFromContext(cookieHeader, tagId) – Remove tag

Workflow operations:

  • server.createWorkflowExecutionFromContext(data) – Create workflow execution

References

For more information, please refer to the official PushFire documentation on NPM: https://www.npmjs.com/package/pushfire