notificationConfiguration [REQUIRED]
This is the root element for all Xtify Notification Configuration API requests.
None
id
apiKey
secret
name
description
appKeys
notificationDeviceTokens
notificationLocations
notificationSchedules
notificationFrequency
notificationContent
id [OPTIONAL]
This element specifies the identification number for the notification configuration. This element is required in the activate, deactivate, and delete API request methods, and optional in the create/update methods. Providing an id in the create/update method request will overwrite the specified notification with the provided data, while not providing it will create a new notification and return its id in the response.
In all API responses, the id element designates the notification that the action was applied to.
String
notificationConfiguration
None
appKeys [REQUIRED]
This element is the root element for one or more applications. It is required if including application elements. An applications element, a notificationDeviceToken, or both must be included in each create/update request.
notificationConfiguration
key
key [OPTIONAL]
An element containing credentials for a single application. If specified, the notification will be associated with all the users belonging to this application.
appKeys
None
apiKey [REQUIRED]
The element containing the api key associated with your application. This value can be found in the Developer Tools section of the Xtify Web Console. Required if application element is included.
notificationConfiguration
None
notificationDeviceTokens
The root element for configuring notifications for individual users of one or more devices. A notificationDeviceToken element, an applications element, or both must be included in each create/update request.
notificationConfiguration
androidDeviceTokens
iPhoneDeviceTokens
blackberryDeviceTokens
androidDeviceTokens [OPTIONAL]
An element containing one or more Android device tokens to be associated with this notification. At least one of androidDeviceTokens, iPhoneDeviceTokens, or blackberryDeviceTokens, is required in a notificationDeviceTokens element.
notificationDeviceTokens
token
token [OPTIONAL]
String
This element contains an Android, iPhone, or Blackberry device token that will be associated with the notification being built. At least one token element is required if any parent element is specified.
androidDeviceTokens
iPhoneDeviceTokens
blackberryDeviceTokens
None
iphoneDeviceTokens
An element containing one or more iPhone device tokens to be associated with this notification. At least one of androidDeviceTokens, iPhoneDeviceTokens, or blackberryDeviceTokens, is required in a notificationDeviceTokens element.
notificationDeviceTokens
token
blackBerryDeviceTokens
An element containing one or more Blackberry device tokens to be associated with this notification. At least one of androidDeviceTokens, iPhoneDeviceTokens, or blackberryDeviceTokens, is required in a notificationDeviceTokens element.
notificationDeviceTokens
token
notificationLocations [OPTIONAL]
The notificationLocations element contains one or more locations where this notification will be triggered for users. As with all rule elements, the notification will fire if and only if the criteria for each associated rule is also satisfied. Either a triggering location or triggering schedule is required.
notificationLocations
location
location [OPTIONAL]
An element describing a single location where notifications will be triggered for specified users. At least one location must be included in a notificationLocations element.
notificationConfiguration
name
description
address
lat
lng
radius
name
String
A descriptive title for the location being created. Note that this is a non-programmatic field and will not be used to trigger the notification, only for display in the message content. This will replace the dynamic field $location in the notificationContent section if you choose to reference location in your notification content.
location
None
description [OPTIONAL]
String
A description of the location being created. Note that this is a non-programmatic field and will not be used to trigger the notification, only for display in the message content. This will replace the dynamic field $description in the notificationContent section if you choose to reference location in your notification content.
location
None
Address [OPTIONAL]
The address of the location being created. Note that this is a non-programmatic field and will not be used to trigger the notification, only for display in the message content. This will replace the dynamic field $address in the notificationContent section.
location
None
lat [OPTIONAL]
long
The element defining the latitude of the desired location. Required for location element.
location
None
lng [OPTIONAL]
long
The element defining the longitude of the desired location. Required for location element.
location
None
radius [OPTIONAL]
long
The element defining the radius (in meters) of circle surrounding the triggering location.
location
None
notificationSchedule [REQUIRED]
The notificationSchedule element contains one or more schedules when this notification will be triggered for users. A notification will be sent at the start time of each configured schedule element (potentially on a repeating basis) in the users' timezone, or immediately if an activation request is received during a schedule window. As with all rule elements, the notification will fire if and only if the criteria for each associated rule is also satisfied.
notificationConfiguration
schedule
schedule [REQUIRED]
An element describing a schedule when notifications will be triggered for specified users. At least one schedule must be included in a notificationSchedule element.
notificationSchedule
startDate
endDate
startTime
endTime
daysOfWeek
startDate [REQUIRED]
String
mm/dd/yyyy
The first date for which this firing schedule begins.
schedule
None
endDate [REQUIRED]
String
mm/dd/yyyy
The last date for which this schedule is active.
schedule
None
startTime [REQUIRED]
String
hh:mm
00:00-23:59
The start time of this schedule in 24 hour notation (i.e. 00:00 to 23:59). A notification will be sent at this time if activated.
schedule
none
endTime [REQUIRED]
String
hh:mm
00:00-23:59
The end time of this schedule in 24-hour notation.
schedule
none
daysOfWeek [OPTIONAL]
int
0-6
0,1,2,3,4,5,6
Days of the week when this notification schedule should be triggered on, in comma separated number format, (e.g. 0 = Sunday; 1 = Monday; etc.).
schedule
None
notificationFrequency [REQUIRED]
notificationFrequency is a rule element to place restrictions on the number and rate at which any user can receive this notification. This rule is critical to achieving the desired functionality of the Xtify notification system because if location updates are enabled on the device SDK, they will continuously attempt to trigger a message. As with all rule elements, the notification will fire if and only if the criteria for each associated rule is also satisfied.
notificationConfiguration
maxNotificationsPerUser
minimumMinutesBetweenNotifications
maxNotificationsPerUser [REQUIRED]
The maxNotificationsPerUser element defines the maximum number of copies of this notification that any one user can receive. maxNotificationsPerUser, minimumMinutesBetweenNotifications or both are required for the notificationFrequency element.
int
notificationFrequency
None
minimumMinutesBetweenNotifications [REQUIRED]
int
The minimumMinutesBetweenNotifications element limits the number of minutes after the last notification was sent that another can be received. As with all rule elements, the notification will fire if and only if the criteria for each associated rule is also satisfied. maxNotificationsPerUser, minimumMinutesBetweenNotifications or both are required for the notificationFrequency element.
notificationFrequency
None
notificationContent [REQUIRED]
This is the root element aggregating the content and data being sent to different types of devices through a notification. Each device content element contains device specific options and attributes to customize the message. Individual device content will only be sent if there is an application of that type associated with this notification.
notificationConfiguration
android
iphone
blackberry
android [OPTIONAL]
The device content element for all users with Android applications. One or more of android, blackberry, or iphone, must be provided.
notificationContent
messageTitle
message
actionIntent
actionCategories
actionData
groupId
url
urlLabel
actionType
collectPollingData
showNotificationScreen
messageTitle [REQUIRED]
String
This is an element defining the title of the message being sent to users.
android
None
message [REQUIRED]
String
This is an element defining the body of the message being sent to users. The number of characters you can pass in this field varies by operating system. For iOS, the limit is 256 characters (characters used for other iPhone elements such as actionButtonLabel, badge and dataItem(s) count against this limit, too). For BlackBerry, the limit is 512 characters. For Android, there is no character limit.
android
blackberry
iphone
None
actionIntent [OPTIONAL]
String
Specifies an operation to be performed upon the user clicking on the primary action button in the notification details screen
android
None
actionCategories [OPTIONAL]
String
Provides additional information about the component that will handle the actionIntent.
android
None
actionData [OPTIONAL]
String
Specifies the data associated with the actionIntent.
android
None
groupId [OPTIONAL]
string
When specified, it groups notifications under the same notification icon in the notification details tray. This field is not currently accessible using the Xtify console.
android
None
url [OPTIONAL]
String
Specifies the url the user will be taken to upon clicking on the primary action button.
android
None
urlLabel [OPTIONAL]
String
Denotes the label to be displayed on the button viewed by a notification recipient when the notification appears on the Android device.
android
None
actionType [OPTIONAL]
String
Specifies what will happen when the notification recipient clicks on the primary action button.
android
None
showNotificationsScreen [OPTIONAL]
boolean
Specifies if the notification screen will be displayed upon notification recipient clicking in the notification tray.
android
None
iphone [OPTIONAL]
The device content element for all users with iPhone applications. One or more of android, blackberry, or iphone, must be provided.
notificationContent
message
badge
sound
actionButtonLabel
actionType
dataItems
actionURL
richSubject
richContent
richActionType
richActionLabel
richActionData
badge [OPTIONAL]
int
Depicts the number shown within a red circle on the application’s home screen icon.
iphone
None
sound [OPTIONAL]
String
Specifies the sound that the phone will play when the notification is received on the device.
iphone
None
actionButtonLabel [OPTIONAL]
String
Denotes the label to be displayed on the action button viewed by a notification recipient when the notification appears on the iPhone.
iphone
None
actionType [OPTIONAL]
Specifies the action for the notification. There are the following possible values: NONE, OPEN_URL (it opens the browser with the url specified at 6.51), RICH_NOTIFICATION (it displays the rich notification with the subject specified at 6.52 and content specified at 6.53) and CUSTOM_DATA (it is defined by the client developer and the data is passed with the value defined at 6.47).
iphone
None
dataItems [REQUIRED if action type is custom]
The item content element for all users with iPhone applications. These values can be passed into the application to determine device activity once the initial notification has been displayed.
iphone
None
item [REQUIRED if dataItems are specified]
Defines the implementation of specific key-value pair(s) that are passed into the application upon action by the notification recipient.
dataItems
key
value
key [REQUIRED if item is specified]
Defines specific implementation key.
item
None
value [REQUIRED if key is specified]
Defines specific implementation value.
item
None
actionURL [REQUIRED if action type is OPEN_URL]
String
Specifies the URL for OPEN_URL action type.
iphone
None
richSubject [REQUIRED if actionType is RICH_NOTIFICATION]
string
Specifies the subject of the rich notification.
iphone
None
richContent [REQUIRED if actionType is RICH_NOTIFICATION]
String
Specifies the content of the rich notification.
iphone
None
richActionType [OPTIONAL]
String
Specifies the action for the rich notification. There are the following possible values: NONE, OPEN_URL (it opens the browser with the url specified at 6.56), PHONE (it opens the dialer with the number defined at 6.56) and CUSTOM_ACTION (it is defined by the client developer and the data is passed with the value defined at 6.56).
iphone
None
richActionLabel [REQUIRED if richActionType is other than NONE]
String
Specifies the label for the action of the rich notification.
iphone
None
richActionData [REQUIRED if richActionType is other than NONE]
String
Specifies the value corresponding to the rich action type.
iphone
None
blackberry [OPTIONAL]
The device content element for all users with BlackBerry applications. One or more of android, blackberry, or iphone must be provided.
notificationContent
message
hasTags [OPTIONAL]
A comma separated list of Tags that a user must have ALL of to receive the notification.
notificationConfiguration
none
notTags [OPTIONAL]
A comma separated list of Tags that a user cannot have to receive the notification.
notificationConfiguration
none