OneSignal Notifications

Overview

• Source: https://onesignal.com
• Image Support: Yes
• Attachment Support: No
• Message Character Limits:
  • Body: 32768

Account Setup

1. Visit https://onesignal.com to create your account.
2. To acquire your {appid} and {apikey} Clic on the Keys and IDs.
   

Syntax

Valid syntax is as follows:

• onesignal://{app_id}@{apikey}/#{include_segment}
• onesignal://{app_id}@{apikey}/#{include_segment1}/#{include_segment2}/#{include_segmentN}
• onesignal://{app_id}@{apikey}/{player_id}/
• onesignal://{app_id}@{apikey}/{player_id1}/{player_id2}/{player_idN}
• onesignal://{app_id}@{apikey}/@{user_id}/
• onesignal://{app_id}@{apikey}/@{user_id1}/@{user_id2}/@{user_idN}
• onesignal://{app_id}@{apikey}/{email}/
• onesignal://{app_id}@{apikey}/{email1}/{email2}/{emailN}

You can also mix/match the targets:

• onesignal://{app_id}@{apikey}/{email}/@{user_id}/#{include_segment}/{player_id}

If you defined a template with OneSignal, you can use it as well:

• onesignal://{template_id}:{app_id}@{apikey}/#{include_segment}
• onesignal://{template_id}:{app_id}@{apikey}/#{include_segment1}/#{include_segment2}/#{include_segmentN}
• onesignal://{template_id}:{app_id}@{apikey}/{player_id}/
• onesignal://{template_id}:{app_id}@{apikey}/{player_id1}/{player_id2}/{player_idN}
• onesignal://{template_id}:{app_id}@{apikey}/@{user_id}/
• onesignal://{template_id}:{app_id}@{apikey}/@{user_id1}/@{user_id2}/@{user_idN}
• onesignal://{template_id}:{app_id}@{apikey}/{email}/
• onesignal://{template_id}:{app_id}@{apikey}/{email1}/{email2}/{emailN}

Parameter Breakdown

Variable	Required	Description
app_id	Yes	This is the Application ID associated with your OneSignal account.
apikey	Yes	This is the API Key associated with your OneSignal account.
template_id	No	The UUID Template ID you wish to use
player_id	No	A Player ID to notify
user_id	No	A User ID to notify. Note: these must be prefixed with an @ symbol or it will be interpreted as a Player ID
include_segment	No	An include segment. Note: these must be prefixed with an # symbol or it will be interpreted as a Player ID
email	No	An email to notify.
subtitle	No	The subtitle of your push. Only appears on iOS devices.
language	No	The 2 character language code to push your message as. By default this is set to en if not specified.
image	No	to include the icon/image associated with the message. By default this is set to yes.
batch	No	Set it to Yes if you want all identified targets to be notified notified in batches (instead of individually). By default this is set to No.

Global Parameters

Variable	Description
overflow	This parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream 👉 upstream: Do nothing at all; pass the message exactly as you received it to the service. 👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated. 👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after.
format	This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verify	External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
cto	This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rto	This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojis	Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tz	Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.

Examples

Send a OneSignal notification to all devices associated with a project:

# Assume:
#  - our {app_id} is abc123
#  - our {apikey} is a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty
#  - our {player_id} is 3456-2345-a3ef
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   onesignal://abc123@a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty/3456-2345-a3ef

# Override the subtitle (Mac users only) by doing the following:
# You must use URL encoded strings, below the spaces are swapped with %20
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   onesignal://abc123@a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty/3456-2345-a3ef?subtitle=A%20Different%20Subtitle

Custom Data (Templates)

Making use of the : on the Apprise URL allows you to alter and add to the payload of your onesignal post.

# As an example:
apprise -vv -b "Test Message Body" \
   "onesignal://credentials/?:key1=value1"

The above would additional these assignments into the payload as `custom_data’:

{
   ... previous payload elements... and then:
   "custom_data": {"key1": "value1"}
}

Data

Making use of the + on the Apprise URL allows you to alter and add to the payload of your onesignal post.

# As an example:
apprise -vv -b "Test Message Body" \
   "onesignal://credentials/?+key1=value1"

The above would additional these assignments into the payload as `data’:

{
   ... previous payload elements... and then:
   "data": {"key1": "value1"}
}