Skip Navigation

Publish alert API

The 
AtHoc
 Publish Alert API defines an XML format to publish alerts through 
BlackBerry AtHoc
.
 The delivery of the message is through one of the delivery devices implemented, such as email, pager, instant message, or through the 
AtHoc
 Desktop software as a desktop popup. A notification message includes a title, message body, and optional URL. In its most basic form, an alert is composed of content, user targeting, delivery devices, and scheduling. All alerts are sent based on templates in the 
BlackBerry AtHoc
 system. Nodes that are not specified fall back to the content in the alert template. Alert payloads that do not specify a template use the New Alert template.
The following topics are covered in this chapter:
  • How to use the Publish Alert API
  • How to publish alerts in the enterprise
  • How to customize device options
  • Sample payloads for various types of alerts