notiflowsDocs

Overview

Client-side API for managing user-specific feed entries, notification states, and preferences

User API

The Notiflows User API provides endpoints for browser and mobile clients to manage user-specific feed entries and notification states.

Base URL

https://api.notiflows.com/api/user/v1

Authentication

All endpoints require User authentication. The headers depend on your security mode:

Secure Mode (Recommended for production):

  • x-notiflows-api-key: Your project's API key
  • x-notiflows-user-key: JWT token signed with your Application Signing Key (RS256)

Development Mode:

  • x-notiflows-api-key: Your project's API key
  • x-notiflows-user-id: The user's external ID directly

See the Authentication Guide for setup instructions and code examples.

API Endpoints

Authentication

Set up secure client authentication with Application Signing Keys.

View Authentication Guide →

Channel Settings

Manage user-specific channel settings and preferences.

Feed

Access and manage notification feed entries, including marking entries as read, seen, clicked, or archived.

Preferences

Retrieve and update user notification preferences.

Getting Started

  1. Generate an Application Signing Key in your project settings
  2. Generate JWT tokens for your users in your backend
  3. Include the authentication headers in all client requests
  4. Use the endpoints below to manage user-specific data

On this page