ComRaidComRaid Docs

Set up push

Connect Firebase and Apple to your Project, copy the Mobile App ID, and configure categories and identity verification.

Before ComRaid can deliver a Notification, your Project needs credentials for each push provider your app uses: FCM (Firebase Cloud Messaging) for Android, and APNs (Apple Push Notification service) for iOS. You set these up once per Project under Push → Push settings.

Admins only

Push settings are only available to organization Admins. Operators see an "only available to organization admins" message instead, and can only see whether a provider is configured.

Before you start

You need:

  • Access to the app's Firebase project (Android, and iOS apps that use Firebase Messaging).
  • Access to the Apple Developer account that owns the iOS app, plus the app's Bundle ID (for example com.acme.app).
  • The Admin role in your ComRaid organization.

Connect Android (FCM)

1. Get a Firebase service account key

  1. Open the Firebase console and select your project.
  2. Go to Project settings → Service accounts.
  3. Click Generate new private key. A JSON file downloads.

Keep this file secret. Anyone who has it can send push to your app.

2. Save it in ComRaid

  1. In the Dashboard, open Push → Push settings → Android.

  2. Copy these values from the JSON file into the Service account form:

    Dashboard fieldJSON fieldExample
    Firebase project IDproject_idacme-prod
    Client emailclient_emailfirebase-adminsdk-…@acme-prod.iam.gserviceaccount.com
    Private keyprivate_keythe full block, from -----BEGIN PRIVATE KEY----- to -----END PRIVATE KEY-----
  3. Click Save provider.

3. Test the credentials

Click Test credentials. A green Credentials authenticated message means Google accepted your service account.

  • The test uses the saved credentials. If you have unsaved edits, save first.
  • The test only checks sign-in with Google. It does not send anything to a device. To check a real device, see Next: send a test push.

Connect iOS (APNs)

1. Get an APNs key from Apple

  1. In Apple Developer, go to Certificates, Identifiers & Profiles → Keys and click +.
  2. Name the key, enable Apple Push Notifications service (APNs), and click Continue → Register.
  3. Click Download to get the .p8 file. Apple only lets you download it once, so store it safely.
  4. Note the Key ID shown on the key's page.
  5. Note your Team ID, shown under Membership details in your Apple Developer account.

2. Save it in ComRaid

  1. Open Push → Push settings → iOS.

  2. Fill in the Apple credentials form:

    FieldWhere to find itExample
    Bundle IDYour iOS app's bundle identifiercom.acme.app
    Key IDThe APNs key's page in Apple DeveloperABC123DEFG
    Team IDMembership details in Apple DeveloperTEAMID1234
    Private key (.p8)Open the .p8 file in a text editor and paste all of it-----BEGIN PRIVATE KEY----- …
  3. Click Save provider, then Test credentials.

The iOS test is a partial check

Test credentials on the iOS tab only confirms that the saved .p8 key is valid. It does not contact Apple, so a wrong Bundle ID, Key ID, or Team ID still passes. Send a test push to an iPhone to confirm the full setup.

You don't choose between Apple's sandbox and production servers here. The ComRaid SDK reports this for each device when it registers. For example, the React Native SDK uses sandbox in development builds.

Using Firebase on iOS?

If your iOS app gets its push token from Firebase Messaging instead of directly from Apple, those devices are delivered through FCM. Then you only need the Android (FCM) setup above. Make sure the Firebase project also has your APNs key uploaded, as Firebase requires. See Push providers.

Copy the Mobile App ID

Your mobile app identifies its Project to ComRaid with the Mobile App ID, a value starting with cr_app_. It's on Push → Push settings → Android, below the FCM form.

  1. Click the copy button next to App ID.
  2. Add it to your app's ComRaid SDK configuration. See the Android, iOS, or React Native SDK guide.

The App ID is publishable. It's safe to ship inside your app. It can only register devices and read settings through /mobile/*, and it can't send Notifications. Sending uses a secret API key (cr_sk_…) that stays on your server. See API keys.

Rotating the App ID

Click Rotate only if you need to replace the ID, for example after it was misused.

Rotation takes effect immediately

The old App ID stops working the moment you confirm. There is no grace period. Installed apps can't register devices or sync categories until you ship an app update with the new ID. Rotation doesn't affect your secret API keys or existing device registrations.

Change saved credentials

Once saved, the credentials form is read-only, and private keys are never shown again.

  1. Click Edit credentials.
  2. Change the fields you need. Leave Private key empty to keep the current key, or paste a new one to replace it.
  3. Click Save provider, then Test credentials again.

Click Cancel edit to discard your changes.

Set up Android notification categories

Android groups notifications into channels. Users can turn each channel on or off, or change its sound, in the phone's settings. In ComRaid these are called categories. You define them on Push → Push settings → Android Push Categories, and the SDK creates matching channels on each device.

Every new Project starts with one active default category, general. You only need more if you want users to be able to control kinds of Notifications separately, for example "Orders" and "Promotions".

To add one, click Add category and fill in:

FieldWhat it does
NameShown to users in Android settings. ComRaid derives the category slug you use in sends from this name.
DescriptionOptional. Shown under the name in Android settings.
ImportanceHow intrusive the notification is: none, min, low, default, high, or max. Use high for heads-up banners.
SoundOptional. The name of a sound file bundled in your Android app under res/raw (for example chime). ComRaid stores the name only and doesn't host audio. Leave empty for the system sound.
Enable lightsAsk for the LED light, on devices that have one.
VibrationDefault, Off, or Custom pattern: comma-separated off/on durations in milliseconds, for example 0, 250, 100, 250.
Default categoryUsed when a send doesn't specify a category. Only one category can be the default.
ActiveSends that use an inactive category are rejected.

You can't change a channel's sound after it reaches devices

Android locks a channel's sound and importance the first time the channel is created on a device. Editing them in ComRaid won't change them on existing installs. To change them, create a new category and switch your sends to it.

On Android 8 and later, the category's sound is the only sound that plays. A sound set on an individual Notification is ignored.

By default, your app can tell ComRaid "this device belongs to user 123" using only the public App ID. Someone who extracts the App ID from your app could claim to be another user and receive that user's Notifications.

Identity verification prevents this. Your server signs a short-lived token (a JWT) for the logged-in user, and the app passes it to the SDK at login. ComRaid only trusts the user ID when the signature checks out.

Steps

  1. Create a key pair on your server. Generate an RSA key pair. The private key stays on your server. ComRaid only ever needs the public key.
  2. Add the public key. Open Push → Push settings → Identity verification. Enter a Key ID (kid) (any label, for example acme-2026-03), paste the Public key PEM, and click Add public key.
  3. Sign tokens on your server. Use identity.createToken from @comraid/node, or any JWT library with RS256, issuer comraid:{project_id}, and audience comraid:identity. The exact issuer for your Project is shown on the tab. See Authentication.
  4. Ship the app update that passes the token at login.
  5. Turn on "Require Identity verification JWT on login" once your updated app is live.

Turn on Require last

  • With Require on and no active key, every mobile login fails. The tab shows No active identity key.
  • With Require on, devices that logged in without a token stop receiving user-targeted Notifications until the user logs in again with a signed token.

While Require is off, logins without a token still work but are marked unverified. That makes it safe to roll out keys and app updates first.

To replace a key, add the new one first, move your server to it, then click Revoke on the old one.

Next: send a test push

Credentials tests only prove that ComRaid can sign in to Google or Apple. To confirm a phone actually receives a Notification:

  1. Install your app on a phone and let it register for push.
  2. Add that device to your Test devices.
  3. Open the composer and click Test send. See Send a Notification.

From the API

  • Register devices from your app with the SDKs, or from your server with the Endpoints API.
  • Choose a category per send with the category field. See Notifications.
  • Full provider details, including which provider to use for which token: Push providers.
  • Payload keys ComRaid adds to every push for open and click tracking: Notification attribution.

On this page