Documentation

Developer Docs

Everything you need to integrate Notifly into your site, app, or workflow.

Quick Start

Clone the repo, set your .env.local, run prisma migrate, and you're live in under 5 minutes.

npx prisma migrate dev && npm run dev

API Reference

REST endpoints for /api/subscribe, /api/notify, /api/track, /api/vapid-key, and webhooks.

POST /api/notify → { title, body, url }

WordPress Plugin

Install the Notifly WP plugin, enter your domain API key, and posts auto-push on publish.

Settings → Notifly → Paste API Key → Save

Service Worker

Add the 2-line snippet to your site — the service worker registers automatically via the JS SDK.

<script src="https://yoursite.com/sdk.js">

Android & iOS

Integrate FCM for Android and APNs for iOS using the mobile SDK endpoints documented below.

POST /api/subscribe → { platform, token }

Autopilot Triggers

Trigger campaigns programmatically via webhook or cron. Set conditions, schedules, and targets.

POST /api/webhook/notify → { tag, payload }

Environment Variables

DATABASE_URLfile:./dev.db (or postgres://...)Required
NEXTAUTH_SECRETRandom 32+ char secret stringRequired
VAPID_PUBLIC_KEYGenerated via generate-keys.jsRequired
VAPID_PRIVATE_KEYGenerated via generate-keys.jsRequired
VAPID_SUBJECTmailto:you@yourdomain.comRequired
XAI_API_KEYOptional — enables AI assistantOptional