| Id |
string |
|
[optional] |
| Value |
int |
|
[optional] [readonly] |
| Name |
string |
Required for SMS Messages. An identifier for tracking message within the OneSignal dashboard or export analytics. Not shown to end user. |
[optional] |
| Aggregation |
string |
|
[optional] [readonly] |
| IsIos |
bool? |
Indicates whether to send to all devices registered under your app's Apple iOS platform. |
[optional] |
| IsAndroid |
bool? |
Indicates whether to send to all devices registered under your app's Google Android platform. |
[optional] |
| IsHuawei |
bool? |
Indicates whether to send to all devices registered under your app's Huawei Android platform. |
[optional] |
| IsAnyWeb |
bool? |
Indicates whether to send to all subscribed web browser users, including Chrome, Firefox, and Safari. You may use this instead as a combined flag instead of separately enabling isChromeWeb, isFirefox, and isSafari, though the three options are equivalent to this one. |
[optional] |
| IsChromeWeb |
bool? |
Indicates whether to send to all Google Chrome, Chrome on Android, and Mozilla Firefox users registered under your Chrome & Firefox web push platform. |
[optional] |
| IsFirefox |
bool? |
Indicates whether to send to all Mozilla Firefox desktop users registered under your Firefox web push platform. |
[optional] |
| IsSafari |
bool? |
Does not support iOS Safari. Indicates whether to send to all Apple's Safari desktop users registered under your Safari web push platform. Read more iOS Safari |
[optional] |
| IsWPWNS |
bool? |
Indicates whether to send to all devices registered under your app's Windows platform. |
[optional] |
| IsAdm |
bool? |
Indicates whether to send to all devices registered under your app's Amazon Fire platform. |
[optional] |
| IsChrome |
bool? |
This flag is not used for web push Please see isChromeWeb for sending to web push users. This flag only applies to Google Chrome Apps & Extensions. Indicates whether to send to all devices registered under your app's Google Chrome Apps & Extension platform. |
[optional] |
| ChannelForExternalUserIds |
string |
Indicates if the message type when targeting with include_external_user_ids for cases where an email, sms, and/or push subscribers have the same external user id. Example: Use the string "push" to indicate you are sending a push notification or the string "email"for sending emails or "sms"for sending SMS. |
[optional] |
| AppId |
string |
Required: Your OneSignal Application ID, which can be found in Keys & IDs. It is a UUID and looks similar to 8250eaf6-1a58-489e-b136-7c74a864b434. |
[optional] |
| ExternalId |
string |
Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same external_id will be sent again. See Idempotent Notification Requests for more details writeOnly: true |
[optional] |
| Contents |
StringMap |
|
[optional] |
| Headings |
StringMap |
|
[optional] |
| Subtitle |
StringMap |
|
[optional] |
| Data |
Object |
Channel: Push Notifications Platform: Huawei A custom map of data that is passed back to your app. Same as using Additional Data within the dashboard. Can use up to 2048 bytes of data. Example: {"abc": 123, "foo": "bar", "event_performed": true, "amount": 12.1} |
[optional] |
| HuaweiMsgType |
string |
Channel: Push Notifications Platform: Huawei Use "data" or "message" depending on the type of notification you are sending. More details in Data & Background Notifications. |
[optional] |
| Url |
string |
Channel: Push Notifications Platform: All The URL to open in the browser when a user clicks on the notification. Note: iOS needs https or updated NSAppTransportSecurity in plist This field supports inline substitutions. Omit if including web_url or app_url Example: https://onesignal.com
|
[optional] |
| WebUrl |
string |
Channel: Push Notifications Platform: All Browsers Same as url but only sent to web push platforms. Including Chrome, Firefox, Safari, Opera, etc. Example: https://onesignal.com
|
[optional] |
| AppUrl |
string |
Channel: Push Notifications Platform: All Browsers Same as url but only sent to web push platforms. Including iOS, Android, macOS, Windows, ChromeApps, etc. Example: https://onesignal.com
|
[optional] |
| IosAttachments |
Object |
Channel: Push Notifications Platform: iOS 10+ 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 automatically Example: {"id1": "https://domain.com/image.jpg\"}
|
[optional] |
| TemplateId |
string |
Channel: Push Notifications Platform: All Use a template you setup on our dashboard. The template_id is the UUID found in the URL when viewing a template on our dashboard. Example: be4a8044-bbd6-11e4-a581-000c2940e62c |
[optional] |
| ContentAvailable |
bool? |
Channel: Push Notifications Platform: iOS Sending true wakes your app from background to run custom native code (Apple interprets this as content-available=1). Note: Not applicable if the app is in the "force-quit" state (i.e app was swiped away). Omit the contents field to prevent displaying a visible notification. |
[optional] |
| MutableContent |
bool |
Channel: Push Notifications Platform: iOS 10+ Always defaults to true and cannot be turned off. Allows tracking of notification receives and changing of the notification content in your app before it is displayed. Triggers didReceive(_:withContentHandler:) on your UNNotificationServiceExtension. |
[optional] |
| TargetContentIdentifier |
string |
Channel: Push Notifications Platform: iOS 13+ Use to target a specific experience in your App Clip, or to target your notification to a specific window in a multi-scene App. |
[optional] |
| BigPicture |
string |
Channel: Push Notifications Platform: Android Picture to display in the expanded view. Can be a drawable resource name or a URL. |
[optional] |
| HuaweiBigPicture |
string |
Channel: Push Notifications Platform: Huawei Picture to display in the expanded view. Can be a drawable resource name or a URL. |
[optional] |
| AdmBigPicture |
string |
Channel: Push Notifications Platform: Amazon Picture to display in the expanded view. Can be a drawable resource name or a URL. |
[optional] |
| ChromeBigPicture |
string |
Channel: Push Notifications Platform: ChromeApp Large picture to display below the notification text. Must be a local URL. |
[optional] |
| ChromeWebImage |
string |
Channel: Push Notifications Platform: Chrome 56+ Sets the web push notification's large image to be shown below the notification's title and text. Please see Web Push Notification Icons. |
[optional] |
| Buttons |
List<Button> |
Channel: Push Notifications Platform: iOS 8.0+, Android 4.1+, and derivatives like Amazon Buttons to add to the notification. Icon only works for Android. Buttons show in reverse order of array position i.e. Last item in array shows as first button on device. Example: [{"id": "id2", "text": "second button", "icon": "ic_menu_share"}, {"id": "id1", "text": "first button", "icon": "ic_menu_send"}] |
[optional] |
| WebButtons |
List<Button> |
Channel: Push Notifications Platform: Chrome 48+ Add action buttons to the notification. The id field is required. Example: [{"id": "like-button", "text": "Like", "icon": "http://i.imgur.com/N8SN8ZS.png", "url": "https://yoursite.com"}, {"id": "read-more-button", "text": "Read more", "icon": "http://i.imgur.com/MIxJp1L.png", "url": "https://yoursite.com"}] |
[optional] |
| IosCategory |
string |
Channel: Push Notifications Platform: iOS Category APS payload, use with registerUserNotificationSettings:categories in your Objective-C / Swift code. Example: calendar category which contains actions like accept and decline iOS 10+ This will trigger your UNNotificationContentExtension whose ID matches this category. |
[optional] |
| AndroidChannelId |
string |
Channel: Push Notifications Platform: Android The Android Oreo Notification Category to send the notification under. See the Category documentation on creating one and getting it's id. |
[optional] |
| HuaweiChannelId |
string |
Channel: Push Notifications Platform: Huawei The Android Oreo Notification Category to send the notification under. See the Category documentation on creating one and getting it's id. |
[optional] |
| ExistingAndroidChannelId |
string |
Channel: Push Notifications Platform: Android Use this if you have client side Android Oreo Channels you have already defined in your app with code. |
[optional] |
| HuaweiExistingChannelId |
string |
Channel: Push Notifications Platform: Huawei Use this if you have client side Android Oreo Channels you have already defined in your app with code. |
[optional] |
| AndroidBackgroundLayout |
BasicNotificationAllOfAndroidBackgroundLayout |
|
[optional] |
| SmallIcon |
string |
Channel: Push Notifications Platform: Android Icon shown in the status bar and on the top left of the notification. If not set a bell icon will be used or ic_stat_onesignal_default if you have set this resource name. See: How to create small icons |
[optional] |
| HuaweiSmallIcon |
string |
Channel: Push Notifications Platform: Huawei Icon shown in the status bar and on the top left of the notification. Use an Android resource path (E.g. /drawable/small_icon). Defaults to your app icon if not set. |
[optional] |
| LargeIcon |
string |
Channel: Push Notifications Platform: Android Can be a drawable resource name or a URL. See: How to create large icons |
[optional] |
| HuaweiLargeIcon |
string |
Channel: Push Notifications Platform: Huawei Can be a drawable resource name or a URL. See: How to create large icons |
[optional] |
| AdmSmallIcon |
string |
Channel: Push Notifications Platform: Amazon If not set a bell icon will be used or ic_stat_onesignal_default if you have set this resource name. See: How to create small icons |
[optional] |
| AdmLargeIcon |
string |
Channel: Push Notifications Platform: Amazon If blank the small_icon is used. Can be a drawable resource name or a URL. See: How to create large icons |
[optional] |
| ChromeWebIcon |
string |
Channel: Push Notifications Platform: Chrome 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. |
[optional] |
| ChromeWebBadge |
string |
Channel: Push Notifications Platform: Chrome Sets the web push notification icon for Android devices in the notification shade. Please see Web Push Notification Badge. |
[optional] |
| FirefoxIcon |
string |
Channel: Push Notifications Platform: Firefox Not recommended Few people need to set Firefox-specific icons. We recommend setting chrome_web_icon instead, which Firefox will also use. Sets the web push notification's icon for Firefox. 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. |
[optional] |
| ChromeIcon |
string |
Channel: Push Notifications Platform: ChromeApp This flag is not used for web push For web push, please see chrome_web_icon instead. The local URL to an icon to use. If blank, the app icon will be used. |
[optional] |
| IosSound |
string |
Channel: Push Notifications Platform: iOS Sound file that is included in your app to play instead of the default device notification sound. Pass nil to disable vibration and sound for the notification. Example: "notification.wav" |
[optional] |
| AndroidSound |
string |
Channel: Push Notifications Platform: Android ⚠️Deprecated, this field doesn't work on Android 8 (Oreo) and newer devices! Please use Notification Categories / Channels noted above instead to support ALL versions of Android. Sound file that is included in your app to play instead of the default device notification sound. Pass nil to disable sound for the notification. NOTE: Leave off file extension for Android. Example: "notification" |
[optional] |
| HuaweiSound |
string |
Channel: Push Notifications Platform: Huawei ⚠️Deprecated, this field ONLY works on EMUI 5 (Android 7 based) and older devices. Please also set Notification Categories / Channels noted above to support EMUI 8 (Android 8 based) devices. Sound file that is included in your app to play instead of the default device notification sound. NOTE: Leave off file extension for and include the full path. Example: "/res/raw/notification" |
[optional] |
| AdmSound |
string |
Channel: Push Notifications Platform: Amazon ⚠️Deprecated, this field doesn't work on Android 8 (Oreo) and newer devices! Please use Notification Categories / Channels noted above instead to support ALL versions of Android. Sound file that is included in your app to play instead of the default device notification sound. Pass nil to disable sound for the notification. NOTE: Leave off file extension for Android. Example: "notification" |
[optional] |
| WpWnsSound |
string |
Channel: Push Notifications Platform: Windows Sound file that is included in your app to play instead of the default device notification sound. Example: "notification.wav" |
[optional] |
| AndroidLedColor |
string |
Channel: Push Notifications Platform: Android ⚠️Deprecated, this field doesn't work on Android 8 (Oreo) and newer devices! Please use Notification Categories / Channels noted above instead to support ALL versions of Android. Sets the devices LED notification light if the device has one. ARGB Hex format. Example(Blue): "FF0000FF" |
[optional] |
| HuaweiLedColor |
string |
Channel: Push Notifications Platform: Huawei ⚠️Deprecated, this field ONLY works on EMUI 5 (Android 7 based) and older devices. Please also set Notification Categories / Channels noted above to support EMUI 8 (Android 8 based) devices. Sets the devices LED notification light if the device has one. RGB Hex format. Example(Blue): "0000FF" |
[optional] |
| AndroidAccentColor |
string |
Channel: Push Notifications Platform: Android 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" |
[optional] |
| HuaweiAccentColor |
string |
Channel: Push Notifications Platform: Huawei Accent Color used on Action Buttons and Group overflow count. Uses RGB Hex value (E.g. #9900FF). Defaults to device's theme color if not set. |
[optional] |
| AndroidVisibility |
int? |
Channel: Push Notifications Platform: Android 5.0_ ⚠️Deprecated, this field doesn't work on Android 8 (Oreo) and newer devices! Please use Notification Categories / Channels noted above instead to support ALL versions of Android. 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) |
[optional] |
| HuaweiVisibility |
int? |
Channel: Push Notifications Platform: Huawei ⚠️Deprecated, this field ONLY works on EMUI 5 (Android 7 based) and older devices. Please also set Notification Categories / Channels noted above to support EMUI 8 (Android 8 based) 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) |
[optional] |
| IosBadgeType |
string |
Channel: Push Notifications Platform: iOS Describes whether to set or increase/decrease your app's iOS badge count by the ios_badgeCount specified count. Can specify None, SetTo, or Increase. `None` leaves the count unaffected. `SetTo` directly sets the badge count to the number specified in ios_badgeCount. `Increase` adds the number specified in ios_badgeCount to the total. Use a negative number to decrease the badge count. |
[optional] |
| IosBadgeCount |
int? |
Channel: Push Notifications Platform: iOS Used with ios_badgeType, describes the value to set or amount to increase/decrease your app's iOS badge count by. You can use a negative number to decrease the badge count when used with an ios_badgeType of Increase. |
[optional] |
| CollapseId |
string |
Channel: Push Notifications Platform: iOS 10+, Android 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. Limit of 64 characters. |
[optional] |
| WebPushTopic |
string |
Channel: Push Notifications Platform: All Browsers Display multiple notifications at once with different topics. |
[optional] |
| ApnsAlert |
Object |
Channel: Push Notifications Platform: iOS 10+ iOS can localize push notification messages on the client using special parameters such as loc-key. When using the Create Notification endpoint, you must include these parameters inside of a field called apns_alert. Please see Apple's guide on localizing push notifications to learn more. |
[optional] |
| DelayedOption |
string |
Channel: All Possible values are: timezone (Deliver at a specific time-of-day in each users own timezone) last-active Same as Intelligent Delivery . (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. |
[optional] |
| DeliveryTimeOfDay |
string |
Channel: All Use with delayed_option=timezone. Examples: "9:00AM" "21:45" "9:45:30" |
[optional] |
| Ttl |
int? |
Channel: Push Notifications Platform: iOS, Android, Chrome, Firefox, Safari, ChromeWeb 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). Max value to set is 2419200 seconds (28 days). |
[optional] |
| Priority |
int? |
Channel: Push Notifications Platform: Android, Chrome, ChromeWeb Delivery priority through the push server (example GCM/FCM). Pass 10 for high priority or any other integer for normal 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. |
[optional] |
| ApnsPushTypeOverride |
string |
Channel: Push Notifications Platform: iOS valid values: voip Set the value to voip for sending VoIP Notifications This field maps to the APNS header apns-push-type. Note: alert and background are automatically set by OneSignal |
[optional] |
| ThrottleRatePerMinute |
string |
Channel: All Apps with throttling enabled: - the parameter value will be used to override the default application throttling value set from the dashboard settings. - parameter value 0 indicates not to apply throttling to the notification. - if the parameter is not passed then the default app throttling value will be applied to the notification. Apps with throttling disabled: - this parameter can be used to throttle delivery for the notification even though throttling is not enabled at the application level. Refer to throttling for more details. |
[optional] |
| AndroidGroup |
string |
Channel: Push Notifications Platform: Android Notifications with the same group will be stacked together using Android's Notification Grouping feature. |
[optional] |
| AndroidGroupMessage |
string |
Channel: Push Notifications Platform: Android Note: This only works for Android 6 and older. Android 7+ allows full expansion of all 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. &quot;en&quot; (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. Read more: supported languages. Example: {&quot;en&quot;: &quot;You have $[notif_count] new messages"} |
[optional] |
| AdmGroup |
string |
Channel: Push Notifications Platform: Amazon Notifications with the same group will be stacked together using Android's Notification Grouping feature. |
[optional] |
| AdmGroupMessage |
Object |
Channel: Push Notifications Platform: Amazon 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. &quot;en&quot; (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: {&quot;en&quot;: &quot;You have $[notif_count] new messages"} |
[optional] |
| ThreadId |
string |
Channel: Push Notifications Platform: iOS 12+ This parameter is supported in iOS 12 and above. It allows you to group related notifications together. If two notifications have the same thread-id, they will both be added to the same group. |
[optional] |
| SummaryArg |
string |
Channel: Push Notifications Platform: iOS 12+ When using thread_id to create grouped notifications in iOS 12+, you can also control the summary. For example, a grouped notification can say "12 more notifications from John Doe". The summary_arg lets you set the name of the person/thing the notifications are coming from, and will show up as "X more notifications from summary_arg" |
[optional] |
| SummaryArgCount |
int |
Channel: Push Notifications Platform: iOS 12+ When using thread_id, you can also control the count of the number of notifications in the group. For example, if the group already has 12 notifications, and you send a new notification with summary_arg_count = 2, the new total will be 14 and the summary will be "14 more notifications from summary_arg" |
[optional] |
| EmailSubject |
string |
Channel: Email Required. The subject of the email. |
[optional] |
| EmailBody |
string |
Channel: Email Required unless template_id is set. HTML suported The body of the email you wish to send. Typically, customers include their own HTML templates here. Must include [unsubscribe_url] in an <a> tag somewhere in the email. Note: any malformed HTML content will be sent to users. Please double-check your HTML is valid. |
[optional] |
| EmailFromName |
string |
Channel: Email The name the email is from. If not specified, will default to "from name" set in the OneSignal Dashboard Email Settings. |
[optional] |
| EmailFromAddress |
string |
Channel: Email The email address the email is from. If not specified, will default to "from email" set in the OneSignal Dashboard Email Settings. |
[optional] |
| EmailPreheader |
string |
Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null. |
[optional] |
| IncludeUnsubscribed |
bool |
Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared. |
[optional] |
| SmsFrom |
string |
Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. |
[optional] |
| SmsMediaUrls |
List<string> |
Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs. |
[optional] |
| Filters |
List<Filter> |
|
[optional] |
| CustomData |
Object |
Channel: All JSON object that can be used as a source of message personalization data for fields that support tag variable substitution. Push, SMS: Can accept up to 2048 bytes of valid JSON. Email: Can accept up to 10000 bytes of valid JSON. Example: {"order_id": 123, "currency": "USD", "amount": 25} |
[optional] |
![https://domain.com/image.jpg\"}](https://domain.com/image.jpg%5C"%7D){kind=link}
![http://i.imgur.com/N8SN8ZS.png"](http://i.imgur.com/N8SN8ZS.png"){kind=link}
![http://i.imgur.com/MIxJp1L.png"](http://i.imgur.com/MIxJp1L.png"){kind=link}