Connectors Reference
Notiivy is a browser notification service allowing you to engage and communicate with users and customers without exhausting your email channel.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Send notification to recipient |
|
|
AddSubscriber ([internal]string Content-Type, AddSubscriberParameterSubscriber Subscriber) |
Add a recipient as a subscriber |
|
RemoveSubscriber ([internal]string Content-Type, RemoveSubscriberParameterSubscriber Subscriber) |
Remove a recipient as a subscriber |
|
SendToAll ([internal]string Content-Type, SendToAllParameterMessage Detail Message Detail) |
Send a notification to many recipients |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Send notification to recipient
Description: Send a defined browser notification to an individual recipient
Syntax:
NotiivyBrowserNotifications.SendToIndividual ([internal]string Content-Type, SendToIndividualParameterMessage Detail Message Detail)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string
|
|
True |
|
|
Message Detail |
SendToIndividualParameterMessage Detail
|
|
True |
Returns:
Summary: Add a recipient as a subscriber
Description: Adds a recipient as a subscriber and returns their unique subscription url
Syntax:
NotiivyBrowserNotifications.AddSubscriber ([internal]string Content-Type, AddSubscriberParameterSubscriber Subscriber)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string
|
|
True |
|
|
Subscriber |
AddSubscriberParameterSubscriber
|
|
True |
Returns:
Summary: Remove a recipient as a subscriber
Description: Removes a recipient as a subscriber.
Syntax:
NotiivyBrowserNotifications.RemoveSubscriber ([internal]string Content-Type, RemoveSubscriberParameterSubscriber Subscriber)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string
|
|
True |
|
|
Subscriber |
RemoveSubscriberParameterSubscriber
|
|
True |
Returns:
Summary: Send a notification to many recipients
Description: Send a notification to all recipients in a specific category
Syntax:
NotiivyBrowserNotifications.SendToAll ([internal]string Content-Type, SendToAllParameterMessage Detail Message Detail)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
Content-Type |
string
|
|
True |
|
|
Message Detail |
SendToAllParameterMessage Detail
|
|
True |
Returns:
Type:SendToAllResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientUniqueID |
string
|
Uniquely identifiers the recipient when sending notifications to them. This can be a guid in the source system or unique attribute on their record. |
|
RecipientName |
string
|
A name to identify the recipient by. |
|
Category |
string
|
Categorise your recipients for bulk messages. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
statusCode |
integer
|
statusCode |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientUID |
string
|
The recipient unique identifiers |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
statusCode |
integer
|
statusCode |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
category |
string
|
The category of the recipient eg staff customer |
|
notification |
|
notification |
Summary:
Description: notification
Properties:
|
Name |
Type |
Summary |
|
title |
string
|
The title of the notification |
|
body |
string
|
The body of the notification |
|
image |
string
|
The url of an image to display at the top of the notification |
|
icon |
string
|
The url of an icon to display on the notification |
|
requireInteraction |
boolean
|
Requires the recipient to close the notification before hiding |
|
actions |
array of (ActionsItem)
|
Notification buttons (2 max) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
action |
string
|
Button action url |
|
title |
string
|
Button text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
statusCode |
integer
|
statusCode |
|
message |
string
|
message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
recipientuid |
string
|
The unique ID of the recipient you are sending the notification to |
|
notification |
|
notification |
Summary:
Description: notification
Properties:
|
Name |
Type |
Summary |
|
title |
string
|
The title of the notification |
|
body |
string
|
The body of the notification |
|
image |
string
|
The url of an image to display at the top of the notification |
|
icon |
string
|
The url of an icon to display on the notification |
|
requireInteraction |
boolean
|
Requires the recipient to close the notification before hiding |
|
actions |
array of (ActionsItem)
|
Notification buttons (2 max) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
action |
string
|
Button action url |
|
title |
string
|
Button text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
statusCode |
integer
|
statusCode |
|
message |
string
|
message |