API Reference

Notiflows provides three APIs for different use cases:

Admin API

The Admin API is designed for server-to-server operations. Use it to manage notifications, users, topics, subscriptions, and deliveries from your backend services.

Base URL: https://api.notiflows.com/admin/v1

Authentication: Requires Admin API keys

• x-notiflows-api-key: Your project's API key
• x-notiflows-secret-key: Your project's secret key

View Admin API Documentation →

User API

The User API is designed for browser and mobile clients. Use it to manage user-specific feed entries, notification states, and preferences.

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

Authentication: Requires User authentication

• x-notiflows-api-key: Your project's API key
• x-notiflows-user-key: JWT signed with your Application Signing Key (production)
• x-notiflows-user-id: User's external ID directly (development only)

View User API Documentation →

View Authentication Guide →

Management API

The Management API is designed for managing your notification infrastructure as code — from the CLI, CI/CD pipelines, MCP servers, or AI agents. Use it to create, validate, publish, and run notiflows.

Base URL: https://api.notiflows.com/management/v1

Authentication: Requires an account token

• Authorization: Bearer nf_at_…: Your account token (created in the dashboard under Account tokens)

View Management API Documentation →

Getting Started

1. Get your API keys from your Notiflows dashboard
2. Choose the right API based on your use case:
   • Use Admin API for backend/server runtime operations
   • Use User API for client-side operations
3. Authenticate your requests with the appropriate headers
4. Explore the endpoints in the respective API documentation sections