OneSignal

OneSignal integration (Communication, Marketing). Imported from open-connector.

API key4 toolshttps://api.onesignal.com

POST

onesignal_rest_api_create_push_notification

Create a push notification for the connected OneSignal app using one official targeting method.

/notifications

17 parameters

Param	Type	Required	Description
contents	object	optional	Localized push notification body keyed by language code.
headings	object	optional	Localized push notification title keyed by language code.
subtitle	object	optional	Localized push notification subtitle keyed by language code.
name	string	optional	Optional OneSignal message name.
included_segments	array	optional	Segments targeted by this push notification.
excluded_segments	array	optional	Segments explicitly excluded from delivery.
include_aliases	object	optional	Mapping of OneSignal alias labels to one or more alias values.
include_subscription_ids	array	optional	Direct subscription ids targeted by this push notification.
filters	array	optional	OneSignal filter objects used as the targeting method.
template_id	string	optional	The OneSignal template UUID.
send_after	string	optional	Scheduled delivery time string accepted by OneSignal.
url	string	optional	Optional URL to open from the notification.
web_url	string	optional	Optional web URL to open from the notification.
app_url	string	optional	Optional app deep link to open from the notification.
data	object	optional	Custom push data included in the message payload.
custom_data	object	optional	Template personalization data included in the request.
content_available	boolean	optional	Whether to set content_available for silent delivery.

GET

onesignal_rest_api_list_messages

List messages from the connected OneSignal app.

/notifications

5 parameters

Param	Type	Required	Description
limit	integer	optional	Maximum number of messages to return.
offset	integer	optional	Pagination offset for the message list.
kind	number	optional	The OneSignal message kind filter: 0 for API-created, 1 for automated, or 3 for…
template_id	string	optional	The OneSignal template UUID.
time_offset	string	optional	The sequential time_offset token returned by OneSignal.

GET

onesignal_rest_api_get_message

Retrieve one OneSignal message by id from the connected app.

/notifications/{messageId}

2 parameters

Param	Type	Required	Description
message_id	string	required	The OneSignal message identifier.
messageId	string	required	Path parameter: messageId

DELETE

onesignal_rest_api_cancel_message

Cancel one scheduled OneSignal message by id.

/notifications/{messageId}

2 parameters

Param	Type	Required	Description
message_id	string	required	The OneSignal message identifier.
messageId	string	required	Path parameter: messageId