OneSignal Integrations
Do more with OneSignal integrations
Zapier lets you connect OneSignal with thousands of the most popular apps, so you can automate your work and have more time for what matters most—no code required.
- Free forever for core features
- 14 day trial for premium features & apps


Top companies trust Zapier to automate work and free up time
Connect your apps and automate workflows
Easy automation for busy people. Zapier moves info between your web apps automatically, so you can focus on your most important work.
New Notification Created
Triggers when you have one or more new notifications created.
Try ItContent by Language
Required unless `content_available=true` or `template_id` is set.
The notification's content (excluding the title), a map of language codes to text for each language.
Each hash must have a language code string for a key, mapped to the localized text you would like users to receive for that language. This field supports inline substitutions. English must be included in the hash.
Example:
en
:English content
es
:Spanish content
Click here to see the list of allowed language codes.
Please use the two-letter language code as the label, then your message for that language as the value. The value for 'en' will be used as the default for all unspecified languages.
Heading by Language
The notification's title, a map of language codes to text for each language. Each hash must have a language code string for a key, mapped to the localized text you would like users to receive for that language. A default title may be displayed if a title is not provided. This field supports inline substitutions.
Example:
en
:An English title
es
:A Spanish title
Subtitle by Language
Supported on iOS 10+ only.
The notification's subtitle, a map of language codes to text for each language. Each hash must have a language code string for a key, mapped to the localized text you would like users to receive for that language. A default title may be displayed if a title is not provided. This field supports inline substitutions.
Example:
{"en": "English Subtitle", "es": "Spanish Subtitle"}
Template ID
Use a template you setup on our dashboard. You can override the template values by sending other parameters with the request. The template_id is the UUID found in the URL when viewing a template on our dashboard.
Example:
.be4a8044-bbd6-11e4-a581-000c2940e62c
iOS Content Available
Supported on iOS only.
Sending
true
wakes your app from background to run custom native code (Apple interprets this ascontent-available=1
). Note: Not applicable if the app is in the "force-quit" state (i.e app was swiped away). Omit thecontents
field to prevent displaying a visible notification.iOS Mutable Content
Sending
true
allows you to change the notification content in your app before it is displayed. TriggersdidReceive(_:withContentHandler:)
on your UNNotificationServiceExtension.Filters
Due to the complexity of supporting different types of user targeting, this field uses JSON to describe targeting filters.
Please see our documentation on Sending to Users Based on Filters.
An example from our documentation is below:
[ {"field": "tag", "key": "level", "relation": ">", "value": "10"}, {"field": "amount_spent", "relation": ">","value": "0"} ]
Note: This field is incompatible with other targeting parameters like
included_segments
orexcluded_segments
.Segment Names to Send ToRequired
The segment names you want to target. Users in these segments will receive a notification. This targeting parameter is only compatible with
excluded_segments
.Example:
["Active Users", "Inactive Users"]
. UseAll
to send to all users.Segment Names of Excluded Users
The names of segments for users to exclude from receiving this notification. If a user is a member of any of the segments in this list, they will not receive the notification.
Can not be combined with include_player_ids, include_ios_tokens, include_android_reg_ids, include_wp_urls, or tags.
Player (User) IDs to Send To
OneSignal device ids to send this message to.
Can not be combined with included_segments, excluded segments, or tags.
IOS Device Tokens to Send To
IOS tokens to send this notification to. If a OneSignal user does not yet exist with this token, a new user will be created.
Can not be combined with included segments, excluded segments, or tags.
Android Reg IDs to Send To
Android registration ids to send this notification to. If a OneSignal user does not yet exist with a specified registration id, a new user will be created.
Can not be combined with included_segments, excluded segments, or tags.
Amazon Reg IDs to Send To
Amazon registration ids to send this notification to. If a OneSignal user does not yet exist with a specified registration id, a new user will be created.
Can not be combined with included_segments, excluded segments, or tags.
Windows Phone 8.0 URIs to Target
Windows Phone device URLs to send this notification to. If a OneSignal user does not yet exist with one of these URLs, a new user will be created.
Can not be combined with included segments, excluded segments, or tags.
Windows Phone 8.1 URIs to Target
Windows Phone 8.1 device URLs to send this notification to. If a OneSignal user does not yet exist with one of these URLs, a new user will be created.
Can not be combined with included segments, excluded segments, or tags.
Send to IOS
Send this message to iOS devices?.
Send to Android
Send this message to Android devices?.
Send to Windows Phone 8.0
Send to Windows Phone 8.0 apps?.
Send to Windows Phone 8.1
Send to Windows Phone 8.1 devices.
Send to Amazon Kindle Devices
Send to Amazon ADM devices?.
Send to Chrome Web Push Devices
Send to Chrome Web Notification subscribers?.
Send to Firefox Web Push Devices
Send to Firefox Web Notification subscribers?
Send to Safari on Mac OS X
Send to Safari browser on Mac OS X (iOS not supported).
Send to All Supported Browsers
Send to all supported web browsers including Chrome, Firefox, and Safari on Mac OS X, and Chrome on Android web browsers.
Send to Chrome App or Extension
Send to Google Chrome App/Extension? .
Custom Data
Custom key value pairs that you can programmatically read in your app's code.
Browser URL to Open
When the user opens the notification their web browser will open this url. Example:
http://google.com
.iOS Media Attachments
IOS 10+ only.
Adds media attachments to notifications. Set as JSON object, key as a media id of your choice and the value as a valid local filename or URL. User must press and hold on the notification to view.
Do not set
mutable_content
to download attachments. The OneSignal SDK does this automaticallyExample:
{"id1": "``https://domain.com/image.jpg``"}
.Android Big Picture
Specific Android picture to display in the expanded view. Can be a drawable resource name or a URL.
Amazon Big Picture
Picture to display in the expanded view. Can be a drawable resource name or a URL.
Chrome Extensions Big Picture
Note: Not for web push. For web push, please see web_push_image instead.
Large picture to display below the notification text. Must be a local URL.
Native App Buttons
Buttons to add to the notification. The key should be the ID of the button (Readable in your app code when a user presses the button), and the value should be the label shown to users for the button. Supported when using the OneSignal Plugin in your app with iOS 8.0 and Android 4.1+ devices.
Web Push Buttons
Chrome 48+ only.
Add action buttons to web push notifications.</p>
Unlike native buttons above, the key below should be the button text, and the value should be the URL users are navigated to when clicking the action button.
.Custom iOS Buttons (Ios_category
Category APS payload, use with
registerUserNotificationSettings:categories
in your Objective-C / Swift code.</p>Example:
iOS 10+ This will trigger your [UNNotificationContentExtension](https://developer.apple.com/reference/usernotificationsui/unnotificationcontentextension) whose ID matches this category.calendar
category which contains actions likeaccept
anddecline
Android Background Layout
Allowing setting a background image for the notification. This is a JSON object containing the following keys. See our Background Image documentation for image sizes.
image
- Asset file, android resource name, or URL to remote image.headings_color
- Title text color ARGB Hex format. Example(Blue):"FF0000FF"
.
Example: `{"image": "https://domain.com/background_image.jpg", "headings_color": "FFFF0000", "contents_color": "FF00FF00"}`.contents_color
- Body text color ARGB Hex format. Example(Red):"FFFF0000"
Android Small Icon
Specific Android icon to use. If blank the app icon is used. Must be the drawable resource name.
Android Large Icon
Specific Android icon to display to the left of the notification. If blank the small_icon is used. Can be a drawable resource name or a URL.
Amazon Small Icon
Specific Amazon icon to use. If blank the app icon is used. Must be the drawable resource name.
Amazon Large Icon
Specific Amazon icon to display to the left of the notification. If blank the
adm_small_icon
is used. Can be a drawable resource name or a URL.Web Push Icon
Sets the web push notification's icon. An image URL linking to a valid image. Common image types are supported; GIF will not animate. We recommend 256x256 (at least 80x80) to display well on high DPI devices. Firefox will also use this icon, unless you specify
firefox_icon
. Safari web push icons cannot be customized on a per-notification basis.Chrome Web Image
Sets the web push notification's large image to be shown below the notification's title and text. Please see Web Push Notification Icons.
Supported only in Chrome 56+.
IOS Sound
Sound file that is included in your app to play instead of the default device notification sound. Example: notification.wav.
Android Sound
Sound file that is included in your app to play instead of the default device notification sound. NOTE: Leave off file extension for Android. Example: notification.
Amazon Sound
Sound file that is included in your app to play instead of the default device notification sound.
NOTE: Leave off file extension for Android.
Example:
."notification"
Windows Phone 8.0 Sound
Sound file that is included in your app to play instead of the default device notification sound. Example: notification.wav.
Windows 8.1 Sound
Sound file that is included in your app to play instead of the default device notification sound.
Example:
."notification.wav"
Android LED Color
Sets the devices LED notification light if the device has one. ARGB Hex format.
Example(Blue):
."FF0000FF"
Android Accent Color
Sets the background color of the notification circle to the left of the notification text. Only applies to apps targeting Android API level 21+ on Android 5.0+ devices.
Example(Red):
."FFFF0000"
Android Visibility
Android 5.0+ only.
Sets the lock screen visibility for apps targeting Android API level 21+ running on Android 5.0+ devices.
1
= Public (default) (Shows the full message on the lock screen unless the user has disabled all notifications from showing on the lock screen. Please consider the user and mark private if the contents are.)0
= Private (Hides message contents on lock screen if the user set "Hide sensitive notification content" in the system settings)
.-1
= Secret (Notification does not show on the lock screen at all)IOS Badge Actions
Options are: None, SetTo, or Increase. None leaves the count unaffected on the device. If you use Increase, it will be based on the current value of the player's badge count.
IOS Badge Count
Sets or increases the badge icon on the device depending on the badge type value.
Notification Replacement Key
IOS 10+ and Android only.
Only one notification with the same id will be shown on the device. Use the same id to update an existing notification instead of showing a new one. This is known as
apns-collapse-id
on iOS andcollapse_key
on Android..Android Grouping String
All notifications with the same group will be stacked together using Android's Notification Stacking feature.
Android Grouping Stacked Message
Summary message to display when 2+ notifications are stacked together. Default is "# new messages". Include
$[notif_count]
in your message and it will be replaced with the current number.Languages - The value of each key is the message that will be sent to users for that language.
"en"
(English) is required. The key of each hash is either a a 2 character language code or one of zh-Hans/zh-Hant for Simplified or Traditional Chinese.Example:
{"en": "You have $[notif_count] new messages"}
Amazon Grouping String
All notifications with the same group will be stacked together using Android's Notification Stacking feature.
Amazon Grouping Stacked Message
Summary message to display when 2+ notifications are stacked together. Default is "# new messages". Include $[notif_count] in your message and it will be replaced with the current number. "en" (English) is required. The key of each hash is either a a 2 character language code or one of zh-Hans/zh-Hant for Simplified or Traditional Chinese. The value of each key is the message that will be sent to users for that language.
Example:
{"en": "You have $[notif_count] new messages"}
Send After
Schedule notification for future delivery. Example: Fri May 02 2014 00:00:00 GMT-0700 (PDT).
Scheduling Per-User Delay Option
Possible values are "timezone" (Deliver at a specific time-of-day in each users own timezone), and "last-active" (Deliver at the same time of day as each user last used your app). If "send_after" is used, this takes effect after the "send_after' time has elapsed.
Time of Day to Deliver
Use with delayed_option=timezone. Example: "9:00AM".
Notification Time to Live
Time To Live - In seconds. The notification will be expired if the device does not come back online within this time. The default is 259,200 seconds (3 days).
Platforms: iOS, Android, Web Push, Chrome Ext.
Message Priority
Delivery priority through the push server (example GCM/FCM). Pass
10
for high priority. Defaults to normal priority for Android and high for iOS. For Android 6.0+ devices setting priority to high will wake the device out of doze mode.Platforms: iOS, Android, Web Push, Chrome Ext.
Notification ContentRequired
Title
The title to be displayed above the content of your notification on each device that receives it. This will default to your application title.
Send Time
Send the notifications at this time. This will default to immediately.
Open URL
An optional URL to be opened when the user clicks your notification.
Related categories
Get started for free
You can't add more hours to the day. Zapier is the next best thing.