Your app identifies users via the SDK, registers device tokens, tracks events, and receives messages sent from your backend or the dashboard. Nothing ships until you send or activate. For the product model, see How Payghaam works. It covers users, subscriptions, and how sends work.
Destinations
Start here. Each row is a real page, or for MCP, the install command on this index.
Client
- FlutterOne Dart app for iOS and Android, including the NSE
dart run payghaam_flutter:install - iOSNative Swift. APNs direct. No Firebase required
pod 'Payghaam' - AndroidNative Kotlin with FCM
implementation("com.payghaam:payghaam") - React NativeJS API with native push modules
npm install @payghaam/react-native - WebBrowsers, no provider account
npm install @payghaam/web
Server
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.
Concepts
- How Payghaam worksProjects, users, subscriptions, messages, and journeys
- Users & eventsSubscribers, tags, and journey triggers
- JourneysVisual multi-step automations
- Delivery healthErrors with fix hints you can act on
- REST API overviewEvery API-key route your backend can call.
- SDK vs REST keysSDK keys ship in the app. REST keys stay on your server.
MCP for coding agents
Point Cursor or Claude at @payghaam/mcp-server. It reads what your app already tracks, tells you what’s missing, and drafts journeys from your repo. Drafts only. Send and activate stay in the dashboard.
npx -y @payghaam/mcp-server
API reference
Browse schemas and curl examples for the public REST API in the API reference.