Contact Free trial Login

Working with Notifications

logo cloud active logo hybrid disabled logo server disabled logo pcf disabled

This document deals with calling the CloudHub API. For instructions on how to perform these same tasks more easily via the Runtime Manager UI, see CloudHub and its child pages.

The notifications API allows you to list notifications, create notifications and mark as read. All resources or methods that return or accept a type (except where noted) use the application JSON type. As an example, here’s an example of what the result from the notifications resource looks like.

Alerts and Notifications are a feature that is currently only available for applications deployed to CloudHub workers. They are not available for applications that you deploy via the Runtime Manager to local servers. See Deployment Strategies for more details.
      "domain" : "myapp",
      "username" : "joecloud",
      "priority" : "INFO",
      "message" : "Something happened",
      "createdAt" : "2015-05-10T23:42:53.010Z",
      "read" : false,
      "readOn" : "2015-02-12T19:51:34.428Z",
      "href" : ""},
      "transactionId": "2a097804-f0d5-11e2-b4d2-9dd46521a02d",
      "properties": {
         "recordId" : "1234"
  "total": 1

Notification Object Properties

The following are the properties for applications.

Property Description


The time the notification was created in ISO8601 format.


The application that the notification is associated with, if any.


The URL of the notification. This can be used as the URL to update the notification status.


The notification message.


The priority - INFO, WARN, ERROR


A map of custom properties associated with this notification. These are supplied by an application when creating the notification.


Whether or not the notification has been read.


The time the notification was read in ISO8601 format.


The ID of the tenant that the notification is associated with.


The ID of the transaction that this notification is associated with.


The user who created the notification.

Operations for Notifications

The following is a summary of notification related operations:

Operation Resource Description



Lists notifications for all applications


Create a new notification.



Mark all notifications as read.



Update the status of a notification.

Check out the API Portal of the CloudHub API to see an interactive reference of all the supported resources, methods, required properties and expected responses.

In the API Portal, search among other Mule APIs for the CloudHub API and enter its latest version.

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.