Creating and managing notifications¶

Creating notificastions with cURL¶

curl -X POST https://api.usergrid.com/<org>/<app>/devices/<device_ID>/notifications -d '{"payloads":{<notifier>:<message>}}'

curl -X POST https://api.usergrid.com/<org>/<app>/devices/*/notifications -d '{"payloads":{<notifier>:<message>}}'

curl -X POST https://api.usergrid.com/<org>/<app>/users/<username>/notifications -d '{"payloads":{<notifier>:<message>}}'

curl -X POST https://api.usergrid.com/<org>/<app>/groups/<group_path>/notifications -d '{"payloads":{<notifier>:<message>}}'

curl -X POST https://api.usergrid.com/<org>/<app>/devices;ql=location within <radius> of <lat>,<long>/notifications -d '{"payloads":{<notifier>:<message>}}'

Creating notificastions with Admin portal¶

To create the new notification with the admin portal, do the following:

1. Log in to the admin portal.
2. In the left nav, click Push > Send Notification.
3. From the Notifier drop-down, select the appropriate notifier.
4. Under the notifier name, select one of the following to specify where your notification message should go:

• All Devices to have the message sent to all devices.
• Devices to have the message sent to a particular subset of devices. Enter a comma-separated list of device UUIDs in the box provided.
• Users to have the message sent to a particular subset of users. Enter a comma-separated list of username values in the box provided.
• Groups to have the message sent to a particular subset of user groups. Enter a comma-separated list of group paths in the box provided.

5. In the Notifier Message field, enter the message (payload) you want delivered.
6. If double-quotes are included in your message, you must escape them with a backslash. 7, Under Delivery, select one of the following to specify when the notification should be delivered:

• Now to have the message delivered immediately.
• Schedule for later to choose a date and time at which the message should be delivered.

7. Click Submit.

To create a notification to send multiple messages or target multiple platforms, see the cURL syntax for creating notifications.

Creating notificastions with iOS¶

To send notifications from iOS app code, you use the 11ApigeeAPSDestination11 and ApigeeAPSPayload classes.

With ApigeeAPSDestination, you specify where the notification should go (a particular user or device or user group, for example). With ApigeeAPSPayload, you specify the contents of the message, including any alert text, sound, or badge (items specified by Apple as allowable notification content types). You then use ApigeeDataClient to send the message via Apigee and Apple APNs.

The following code illustrates how to send a notification to a single user. Though this is the device on which the app itself is installed, you can imagine how you might send a notification to another device, such as one belonging to someone “following” this user. For more, see the iOS push sample application included with the Apigee iOS SDK.

- (void)sendMyselfAPushNotification:(NSString *)message
completionHandler:(ApigeeDataClientCompletionHandler)completionHandler
{
    // send to a single device -- our own device
    NSString *deviceId = [ApigeeDataClient getUniqueDeviceID];
    ApigeeAPSDestination* destination =
        [ApigeeAPSDestination destinationSingleDevice:deviceId];

    // set our APS payload
    ApigeeAPSPayload* apsPayload = [[ApigeeAPSPayload alloc] init];
    apsPayload.sound = kBundledSoundNameWithExt;
    apsPayload.alertText = message;

    // Example of what a custom payload might look like -- remember that
    // APNS payloads are limited to a maximum of 256 bytes (for the entire
    // payload -- including the 'aps' part)
    NSMutableDictionary* customPayload = [[NSMutableDictionary alloc] init];
    [customPayload setValue:@"72" forKey:@"degrees"];
    [customPayload setValue:@"3" forKey:@"newOrders"];

    __weak AppDelegate* weakSelf = self;

    // send the push notification
    [dataClient pushAlert:apsPayload
            customPayload:customPayload
              destination:destination
            usingNotifier:notifier
        completionHandler:^(ApigeeClientResponse *response) {
            if ( ! [response completedSuccessfully]) {
                [weakSelf alert:response.rawResponse
                          title: @"Error"];
            }

            if (completionHandler) {
                completionHandler(response);
            }
        }];
}

cURL¶

To schedule a notification for a later time, add the deliver parameter with a UNIX timestamp to the body of your request.

Request body syntax

'{"deliver":<unix_timestamp>,"payloads":{<notifier>:<message>}}'

cURL¶

The following are endpoints can be used to get notifications. For details on the notification properties you can get, see Notifier, Receipt, and Notification.

Getting one or more notifications:

/notifications

Getting notifications associated with one or more receipts:

/receipts/*/notification

Getting the list of devices associated with one or more notifications before the notifications are sent:

/notifications/*/queue

Admin portal¶

You can view JSON for notifications by viewing their entity entries in the Data section of your application.

In the admin portal, click Data, then click the /notifications collection. You can also view notification data in the message history.

In the admin portal, click Push, then click Message History. Locate the notification for which you want to view data, then click its view details link.

Deleting unsent notifications with cURL¶

curl -X DELETE "https://api.usergrid.com/<you-org>/<app>/notifications/<notification-uuid>"

Deleting unsent notifications with Admin Portal¶

1. In the admin portal, click Push, then Message History.
2. On the Message History page, click Scheduled.
3. In the list of scheduled messages, locate the message you want to delete.
4. In the top area of the message item, click the delete link.