OneSignal Documentation

Start building faster with comprehensive guides, example code, and platform overviews for omnichannel messaging.

Dashboard setup

Set up your OneSignal project, configure platforms, and start sending notifications quickly.

Install and integrate the OneSignal SDK with your app to enable messaging capabilities.

Explore our full API reference to automate messaging, manage users, and track delivery.

Set up and send mobile and web push notifications with advanced targeting and automation.

Build, personalize, and send transactional and marketing emails using OneSignal.

Send time-sensitive SMS messages using OneSignal’s powerful messaging engine.

In-app messages

Create in-app messages to engage users while they’re active in your app.

Live Activities

Deliver real-time updates to iOS Live Activities using OneSignal’s SDK and API.

Design no-code messaging journeys across channels to onboard, retain, and re-engage users.

Optimize your messaging with A/B tests to improve engagement and conversion rates.

Track the success of your messaging campaigns with detailed analytics.

Connect OneSignal to 3rd party tools, CRMs, data pipelines, and more via SDKs or webhooks.

Essential Concepts

Master these fundamental concepts to build effective messaging campaigns and understand OneSignal’s core capabilities.

Custom metadata attached to users to store preferences, behaviors, and properties for targeting.

Dynamic groups of users based on criteria like behavior, location, tags, and subscription status.

A User represents an individual with one or more subscriptions to messaging channels like push, email, and SMS.

A subscription in OneSignal represents the specific channel or device through which a user can receive messages.

A unique identifier you assign to link a OneSignal user with your own user system or database.

A unique UUID automatically generated by OneSignal to identify each user in the system.

Personalization

The ability to customize message content using user data, tags, and dynamic content for relevant experiences.

Direct users to specific app screens or web pages with custom deep links and URLs.

Send messages in multiple languages to reach global audiences effectively.

Confirmed Delivery

Verification that a push notification was successfully delivered to and displayed on a user’s device.

Custom Outcomes

Track custom conversion events and measure the impact of your messaging campaigns.

Stream real-time messaging events to external systems for advanced analytics and automation.