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.
SDK setup
Install and integrate the OneSignal SDK with your app to enable messaging capabilities.
API reference
Explore our full API reference to automate messaging, manage users, and track delivery.
Push
Set up and send mobile and web push notifications with advanced targeting and automation.
Email
Build, personalize, and send transactional and marketing emails using OneSignal.
SMS
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.
Journeys
Design no-code messaging journeys across channels to onboard, retain, and re-engage users.
A/B Testing
Optimize your messaging with A/B tests to improve engagement and conversion rates.
Analytics
Track the success of your messaging campaigns with detailed analytics.
Integrations
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.
User Tags
Custom metadata attached to users to store preferences, behaviors, and properties for targeting.
Segmentation
Dynamic groups of users based on criteria like behavior, location, tags, and subscription status.
Users
A User represents an individual with one or more subscriptions to messaging channels like push, email, and SMS.
Subscriptions
A subscription in OneSignal represents the specific channel or device through which a user can receive messages.
External ID
A unique identifier you assign to link a OneSignal user with your own user system or database.
OneSignal ID
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.
Deep Linking
Direct users to specific app screens or web pages with custom deep links and URLs.
Multi-Language
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.
Event Streams
Stream real-time messaging events to external systems for advanced analytics and automation.