Setup Guides

Setup your message channels.

Whether you are migrating to OneSignal or just getting started, we're happy to have you! This checklist walks through getting set up as fast as possible. If you haven't done so already, head to onesignal.com to set up your account.

๐Ÿ“˜

Add your Team!

If you have other team members that need access to your OneSignal instance, see our Account Management page to invite them.

Mobile SDK Setup

Mobile Push

Be the first message customers see when they pick up their phones.

Web SDK Setup

Web Push

Stay in front of your customers even after they leave your site.

Email Setup

Email Setup

Craft beautiful, professional emails that convert and look great on every device.

SMS Setup

SMS

Reach customers directly on their phone for higher engagement and conversion.

In-App Message Setup

In-App Messages

Create interstitials, carousels, banners, and pop-ups that convert.

Live Activities Setup

Live Activities

How to set up Live Activities on your iOS Mobile App with OneSignal

Journeys

Journeys

Craft personalized messaging journeys with our easy-to-use visual builder.

Integrations

Integrations

Integrate OneSignal with third parties.

Backend SDK Setup

SDK Setup

Front-end SDK, Back-end SDK and API reference.

REST API

REST API

Integrate OneSignal with your backend events, data, and more.


FAQ

Are the SDKs required?

No, but they are highly recommended.

OneSignal provides the Create user, Create subscription, Update user, and Update subscription APIs for creating and updating user and subscription data along with the Create notification API sending push notifications, email, and SMS messages. The OneSignal SDK is required if you plan to use the In-App Messaging functionality.

Server API-only integrations are possible but not recommended because push notifications have several different requirements that our SDK handles for you, including:

  • obtaining push tokens across Android, iOS, Huawei, and Web Browsers
  • verifying subscription status, prompting, and opting-in users
  • displaying the notification and handling the payload

For example, the APNS push payload has a standardized format but FCM does not. Setting up both would need additional dev work to handle notifications client side. OneSignal's Push Payload contains a "custom" key with a nested "i" value when sent through our system. Our SDK checks this value to handle the push notification. See OneSignal's Custom Push Payload here and our article on Build vs Buy for more details.