PushNotificationRequest

Represents a request sent through API to command a Push notification (either Email or SMS) to one or more recipients

This is how to push a notification.

PushNotificationRequest Properties

PushNotificationRequest

Field Type Inherited from Description
AttachedImage ObjectLinkItem PushNotificationRequest If Set and delivery type is Email attach the image to the email
EventRecipientKeys String[] PushNotificationRequest Gets or sets the event recipient keys.
Message String PushNotificationRequest Gets or sets the message.
MessageTemplateKey String PushNotificationRequest Gets or sets the message template key.
Metadata MetadataItem PushNotificationRequest Additional meta data that will be made available to the message template
ObjectLinks ObjectLinkItem[] PushNotificationRequest Additional Ojbects that will be made available to the message template
PushNotificationType PushNotificationTypes PushNotificationRequest Gets or sets the PushNotificationType value
RecipientKeys String[] PushNotificationRequest Gets or sets the recipient keys.
Subject String PushNotificationRequest Gets or sets the Subject value

JSON Structure of PushNotificationRequest

{
   "AttachedImage"	:	"[ObjectLinkItem](/object-model/objectlinkitem)",
   "EventRecipientKeys"	:	"String[]",
   "Message"	:	"String",
   "MessageTemplateKey"	:	"String",
   "Metadata"	:	"[MetadataItem](/object-model/metadataitem)",
   "ObjectLinks"	:	"[ObjectLinkItem](/object-model/objectlinkitem)[]",
   "PushNotificationType"	:	"[PushNotificationTypes](/object-model/pushnotificationtypes)",
   "RecipientKeys"	:	"String[]",
   "Subject"	:	"String"
}

Push Notification Async

Example in C#

// Returns: nothing
await client.PushNotificationAsync(FolderInfo folder, PushNotificationRequest request);

Example in CURL



           curl -X DELETE \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/pushnotifications \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{
                       "$type":"Feenics.Keep.WebApi.Model.PushNotificationRequest, Feenics.Keep.WebApi.Model",
                       "RecipientKeys":null,
                       "EventRecipientKeys":null,
                       "Message":"MESSAGE_GOES_HERE",
                       "MessageTemplateKey":"MESSAGE_TEMPLATE_GOES_HERE",
                       "PushNotificationType":0,
                       "Subject":null
                   }'