Payghaam is a multi-channel engagement platform in the mold of the established push notification providers. Your app identifies users via the SDK, registers device tokens, tracks events, and receives messages sent from your backend or the dashboard.
What you can build
- Transactional push — order updates, auth codes, re-engagement from your server with a REST key.
- Audience targeting — tags, segments, and external user IDs.
- Event-driven journeys — automate multi-step flows when users take actions in your app.
- Multi-channel delivery — push (APNs + FCM), SMS, email, and webhooks from one API.
Core concepts
Organization & project
An org holds team members; each project is an isolated app with its own keys, channels, and audience.
Subscriber
An end user identified by external_id — subscriptions, tags, and events attach to them.
SDK vs REST keys
SDK keys ship in your mobile app. REST keys stay on your server for sends and admin.
Delivery log
Every send attempt is recorded with status and actionable error hints in the dashboard.
Explore the docs
- Quick start — Run the platform locally in minutes
- Architecture — API, workers, queues, and data flow
- Users & events — Subscribers, tags, and journey triggers
- Journeys — Visual multi-step automations and templates
- Delivery health — Normalized errors and the notification manager
- Flutter — Cross-platform Dart SDK
- React Native — JS API + native push modules
- Android (Kotlin) — Native Android library
- iOS (Swift) — Native Swift package
- Flutter overview
- iOS setup — APNs, App Groups, NSE
- Android setup — FCM and Gradle
- Authentication — SDK and REST keys
- Users & subscriptions — Identify users and register devices
- Send notifications — Broadcast and targeted sends
- Push (APNs & FCM) — Configure iOS and Android push
- Rich notifications — Images and custom sounds, plus client setup
- Outbound webhooks — Signed delivery & engagement events to your backend
Tip
Running locally? Start with Quick start to bring up Postgres, Redis, the API, worker, and dashboard.
OpenAPI / Swagger
The HTTP API exposes interactive Swagger docs at /api/docs when the API server is running (default port 4000).