2017-10-30 20:39:12 +00:00
# Describes the format for available notification services
2015-11-09 06:15:34 +00:00
2017-10-30 20:39:12 +00:00
notify :
description : Send a notification.
2015-11-09 06:15:34 +00:00
fields :
message :
description : Message body of the notification.
example : The garage door has been open for 10 minutes.
title :
description : Optional title for your notification.
example : 'Your Garage Door Friend'
2015-11-15 19:14:10 +00:00
target :
2016-10-02 05:19:17 +00:00
description : An array of targets to send the notification to. Optional depending on the platform.
2015-11-15 19:14:10 +00:00
example : platform specific
2016-07-13 04:48:33 +00:00
data :
2016-10-02 05:19:17 +00:00
description : Extended information for notification. Optional depending on the platform.
2016-07-13 04:48:33 +00:00
example : platform specific
2016-10-18 02:41:49 +00:00
2019-01-15 23:31:57 +00:00
html5_dismiss :
description : Dismiss a html5 notification.
fields :
target :
description : An array of targets. Optional.
example : [ 'my_phone' , 'my_tablet' ]
data :
description : Extended information of notification. Supports tag. Optional.
example : '{ "tag": "tagname" }'
2016-10-18 02:41:49 +00:00
apns_register :
description : Registers a device to receive push notifications.
fields :
push_id :
description : The device token, a 64 character hex string (256 bits). The device token is provided to you by your client app, which receives the token after registering itself with the remote notification service.
example : '72f2a8633655c5ce574fdc9b2b34ff8abdfc3b739b6ceb7a9ff06c1cbbf99f62'
name :
description : A friendly name for the device (optional).
example : 'Sam' 's iPhone'