Skip to main content
Sendrealm provides SDKs for apps that receive push notifications and for trusted backend code that calls the Sendrealm API.

​
Which SDK Should I Use?

If you are buildingUse this SDK
Native Android appAndroid SDK
Native iOS appiOS SDK
Bare React Native appReact Native Bare SDK
Expo app with prebuild, expo run, or EAS buildsReact Native Expo SDK
React, Vite, or Next.js web appReact Web Push SDK
Backend, worker, queue consumer, or serverless functionJavaScript SDK
Expo Go is not supported for mobile push because Sendrealm uses native Android and iOS code. Use an Expo development build or a production build.

​
Device SDKs

Use a device SDK when your app needs to receive push notifications. Device SDKs help your app:
  • Register the current app install with Sendrealm.
  • Ask for notification permission at the right time.
  • Link the device to a signed-in user.
  • Store app-sourced tags.
  • Track app events for segmentation and automations.
  • Handle notification opens.
Device SDKs use a Sendrealm app ID from the dashboard. They do not use Sendrealm API keys.
Never put a Sendrealm API key in a mobile app or browser app. API keys belong in trusted server-side code.

​
Server SDK

Use the JavaScript SDK from trusted code when you need to call the Sendrealm API. Common backend tasks include:
  • Sending email.
  • Sending push notifications.
  • Creating or updating contacts.
  • Ingesting events.
  • Managing audiences, topics, templates, and automations.
The JavaScript SDK uses a Sendrealm API key. Store the key in your secret manager or environment variables. For mobile push, use this order:
  1. Create or select your Sendrealm app in the dashboard.
  2. Configure the push provider credentials for your platform.
  3. Install the SDK.
  4. Initialize the SDK once during app startup.
  5. Ask for notification permission after explaining the value to the user.
  6. Call login after the user signs in.
  7. Send a test push to a real target device.
  8. Check SDK diagnostics if delivery does not work as expected.

​
What You Need From The Dashboard

Device SDKs need a Sendrealm app ID. Mobile push providers also need platform credentials:
  • Android: Firebase service account JSON and matching Android package name.
  • iOS: APNs .p8 key, Key ID, Team ID, Bundle ID, and APNs environment.
  • Web Push: Web provider enabled in Sendrealm.
See Mobile Push Credentials for the credential walkthrough.

​
Delivery Expectations

Push notifications are best effort. Sendrealm can accept a send request and hand it to Firebase, APNs, or the browser push service, but final delivery and display still depend on the device, operating system, browser, user settings, battery state, app state, network connectivity, and platform policies. Design your app so important state is available when the user opens it, even if a push notification is delayed or not displayed.

​
Where To Go Next