Jump to Content
OneSignal Documentation
GuidesServer REST API Reference
Log InSign UpOneSignal Documentation
Log InSign Up
GuidesServer REST API Reference

OneSignal

  • Documentation

Getting Started

  • Onboarding With OneSignal
  • Mobile Quickstart
    • iOS SDK Setup
    • Android SDK Setup
    • Unity SDK Setup
    • React Native SDK Setup
    • Expo SDK Setup
    • Flutter SDK Setup
    • Ionic & Capacitor SDK Setup
    • Cordova SDK Setup
    • Xamarin SDK Setup
    • .NET SDK Setup
    • macOS App Setup
    • Windows App SDK Setup
    • Huawei SDK Setup
    • Huawei Unity SDK Setup
    • Huawei React Native SDK Setup
    • Huawei Flutter SDK Setup
    • Huawei Xamarin SDK Setup
    • Huawei Cordova SDK Setup
    • Amazon SDK Setup
  • Web Quickstart
    • Angular Setup
    • React JS Setup
    • Vue JS Setup
    • WordPress Setup
    • Local Testing
    • Custom Code Setup
    • Shopify App Setup
    • Webflow Setup
    • Blogger Setup
    • Magento Setup
    • Bubble Setup
    • Squarespace Setup
    • Weebly Setup
    • Drupal Setup
    • Joomla Setup
    • Wix Setup
    • Third-Party Setup Support
    • Google Tag Manager
    • AMP Web Push Setup
    • Legacy Shopify Setup
  • SMS Quickstart
    • Twilio Setup
  • Email Quickstart
    • OneSignal Email Setup
    • Mailgun Setup
    • SendGrid Setup
    • Mailchimp Setup
  • In-App Messages Quickstart
  • Live Activities Quickstart

Features

  • Users & Segments
    • Segments
    • External User Ids
    • Find Devices & Set Test Users
    • Delete Users
  • Sending Messages
    • Automated Messages
    • Templates
    • Drafts
    • Frequency Capping
    • Throttling
    • Language & Localization
    • Retargeting Messages
  • Data Tags
    • How to Add and Edit User Attributes or Data Tags
    • Bulk Updating User Attributes or Data Tags
    • Importing User Attributes or Data Tags
    • Message Personalization
    • Abandoned Cart
    • Time Operators
    • Auto-Segment By Subscription Page
    • Auto-Segment By Notification Data
    • Auto-Segment By Page Visit
    • Data Tags FAQ
  • A/B Testing
    • Push A/B Testing
    • Email A/B Testing
    • Experimentation Best Practices
  • Journeys
    • Journeys Examples
  • Analytics
    • Delivery: Message Reports
    • Push Notification Message Reports
    • Email Message Reports
    • SMS Message Reports
    • Outcomes
    • Confirmed Deliveries
    • Web Push Webhooks
  • Account Management
    • Apps & Organizations
    • Disabled Apps
    • Manage Team Members
    • Keys & IDs
    • Two-Step Authentication
    • Billing FAQ
  • Exporting Data
    • Export User Data
    • Export Message Data
    • Export Outcomes Data
  • Data Handling and Security
    • Data Collected by the OneSignal SDK
    • Handling Personal Data
    • Apple App Privacy Requirements
    • Google Play Data Safety Requirements
    • Identity Verification
    • GDPR & Individual Rights
    • Privacy Policy
    • Terms of Use

Channels

  • Channels Overview
  • Mobile Push Notifications
    • Service Extensions
    • URLs, Links and Deep Links
    • Images & Rich Media
    • Badges
    • Notification Sounds
    • Action Buttons
    • Remove Notifications and TTL
    • Notification Grouping
    • Location-Triggered Notifications
    • Android Customizations
    • Android 13 Push Notification Developer Update Guide
    • Android: Notification Icons
    • Android: Notification Channel Categories
    • Android: Firebase Credentials
    • Huawei: Authorizing OneSignal
    • iOS Customizations
    • iOS: Provisional Push Notifications
    • iOS: Image Carousel Push Notifications
    • iOS: Focus Modes and Interruption Levels
    • iOS: Relevance Score
    • iOS: SDK App Groups setup
    • iOS: Establishing a Connection to APNs
    • iOS: p8 Token-Based Connection to APNs
    • iOS: p12 Generate Certificates
    • iOS: App Clip Support
    • Example: Create Activity Feed
    • Example: User-User Messages
    • Example: Social Activities
    • Data & Background Notifications
    • VoIP Notifications
    • Advanced Notification Settings
  • Web Push Notifications
    • OneSignal Service Worker
    • Safari Web Push on Mobile (iOS/iPadOS)
    • Web Application Manifest
    • Prompting
    • Slide Prompt
    • Category Prompt
    • Email & Phone Number Web Prompt
    • Bell Prompt
    • Custom Link Prompt
    • HTTP PopUp Prompt
    • Native Browser Prompt
    • Web Push Icons & Images
    • Advanced Options
    • Unsubscribe from Web Notifications
    • Web Push Topic & Collapsing
    • WordPress Customizations
    • Shopify App Overview
    • FAQ: Safari Web Push
    • FAQ: Shopify App
    • FAQ: Clearing Cookies
    • FAQ: HTTP vs. HTTPS
    • FAQ: Browser Behavior
    • Use Cases & Best Practices
    • News or Media Site Best Practices
    • Ecommerce Best Practices
    • Getting Your Audience to "Add to Home Screen"
  • In-App Messaging
    • Design In-App Messages with Drag and Drop
    • Design In-App Messages with HTML
    • In-App Message HTML Templates
    • In-App JS Library
    • Analytics of In-App Message
    • How to make a Carousel
    • How to add Click Actions
    • How to add Triggers
    • How to Prompt for Push Permissions with In-App Messages
    • How to Prompt for Location Tracking
    • Example: Ask for App Store Rating
    • Example: App Version Update
    • Example: Personalize In-App Messages
    • Example: In-App Message Tutorial
    • Example: Create A Survey
    • Example: Target Certain Android Manufacturers and Devices
    • Example: Trigger In-App Message from Push Open
    • Example: Trigger In-App Message after closing an In-App Message
  • Email Messaging
    • Import Email Addresses
    • Sending Email Messages
    • Setup a Custom Sender Domain
    • Designing Emails with Drag and Drop
    • Designing Emails with HTML
    • Email Throttling & Warm-Up
    • Email Links and Click Tracking
    • Unsubscribe Links & Email Subscriptions
    • Send Transactional Emails
    • Email Regulatory Compliance
    • Email Acceptable Use Policy & Code of Conduct
  • SMS Messaging
    • Import Phone Numbers
    • Sending SMS Messages
    • Using SMS as a Fallback Option for Push Notifications
  • Live Activities
    • How to Create and Update iOS Live Activities
    • Maximizing Live Activity Engagement
    • Video: Live Activities Office Hours
    • Live Activities: FAQ

Integrations

  • Integrations Overview
  • CDP & User Data Integrations
    • Adobe Audience Manager
    • Amplitude
    • BlueConic
    • Blueshift
    • Database, DMP, & CRM Integration
    • HubSpot
    • Mixpanel
    • Segment.com Integration
  • Analytics Integrations
    • Google Analytics
    • Google Analytics for Firebase
  • Workflow Automation Integrations
    • Zapier
  • Locations & Subscription Integrations
  • CMS & App Builders Integrations
    • GoNative.io

Developer Reference

  • Client SDK Reference
    • SDK Notification Event Handlers
    • OSNotification Payload
    • In-App Message SDK Methods
    • Data Tag SDK Methods
    • Web SDK Methods
    • SMS SDK Methods
    • Email SDK Methods
    • Updating Mobile SDK's - Major Release
  • Server SDK Reference
    • .NET Client SDK
    • CPP Client SDK
    • Go Client SDK
    • Java Client SDK
    • Node Client SDK
    • PHP Client SDK
    • Ruby Client SDK
    • Ruby On Rails Plugin
    • Rust Client SDK
    • Python Client SDK
  • REST API Overview
    • REST API Reference
    • REST API Requirements and FAQ
    • Rate Limits
    • Idempotent Notification Requests
    • Transactional Messages
    • Using Postman
  • Deprecations

Troubleshooting

  • Mobile Troubleshooting
    • Mobile Push FAQ
    • Notifications Not Shown - Mobile Push
    • Notification Images Not Showing
    • Duplicated Notifications
    • Notifications Delayed
    • Troubleshooting Android
    • Troubleshooting iOS
    • Troubleshooting Unity
    • Troubleshooting React-Native
    • Troubleshooting Flutter
    • Troubleshooting Cordova Variants
    • Troubleshooting Xamarin
    • Mismatched Push Certificate
    • Mismatched User Environment
    • Mismatched Bundle ID
    • Android Mismatched Users
    • Bundle / Certificate Mismatch
    • Invalid Push Certificate
    • Invalid Google Credentials
    • Invalid Amazon Credentials
    • No Subscribers Troubleshooting
    • Handling Multiple Push Providers
  • Web Push Troubleshooting
    • Web Push FAQ
    • WordPress Troubleshooting
    • Notifications Not Shown - Web Push
    • Notification CTR
    • Clearing Cache and Resetting Push Permissions
  • In-App Message Troubleshooting
    • Why IAM Data Not Updating?
    • Duplicated In-App Messages
  • SMS Troubleshooting
  • Email Troubleshooting
    • Why Emails Not Showing?
    • Webhooks & Why Email Stats Not Detected?
    • How to improve email deliverability and lower bounce rate?
    • DMARC & Sender Email Address
    • What is DNS Authentication?
  • Journeys Troubleshooting
  • Capturing a Debug Log

Deprecations

Suggest Edits

Updated about 2 months ago