Ally

The Ally Connector allows your company to distribute news and information through our AI-based Converstional Agent called Ally. Use the full potential of AI to maximize your sales and achieve an organization-wide information distribution.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name	Summary
SendNews (SendNewsParameterBody body)	Send news to your organization
SendNotification (SendNotificationParameterBody body)	Send a notification to your organization
GetUsers ()	Load Users in your organization

 

Triggers:

Name

Summary

 

Objects:

Name	Summary
GetUsersResponseItem
SendNewsParameterBody
SendNewsResponse
SendNotificationParameterBody
SendNotificationResponse

 

Actions:

SendNews

Summary: Send news to your organization

Description: Send news to your organization. Notice: If you do not provide a User, Ally is scaning the news and sending it only to users, which are interested in the topic. You can help Ally by adding additional Tags.

 

Syntax:

 

Parameters:

Name	Type	Summary	Required	Related Action
body	SendNewsParameterBody		True

 

Returns:

          Type:SendNewsResponse

 

SendNotification

Summary: Send a notification to your organization

Description: Send notifications to a member of your organization or your whole with this action.

 

Syntax:

 

Parameters:

Name	Type	Summary	Required	Related Action
body	SendNotificationParameterBody		True

 

Returns:

          Type:SendNotificationResponse

 

GetUsers

Summary: Load Users in your organization

Description: This function is mainly used for loading users within your organization.

 

Syntax:

 

Returns:

          Type:array of (GetUsersResponseItem)

 

 

GetUsersResponseItem

Summary:

Description:

 

          Properties:

Name	Type	Summary
id	string
name	string

 

SendNewsParameterBody

Summary:

Description:

 

          Properties:

Name	Type	Summary
Headline	string	The headline of the news.
Text	string	The main text of the news.
URL	string	A URL, where the user can get more information.
PictureURL	string	A URL of an image connected to the news.
Tags	string	Tags, which help Ally to further understand the topic of your text.
TimeToLiveInDays	integer(int32)	The maximum number of days the news will exist in Ally. (Default: 7)
UserId	string	The User, who shall be notified. If empty the whole organization will be notified.

 

SendNewsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

 

SendNotificationParameterBody

Summary:

Description:

 

          Properties:

Name	Type	Summary
Text	string	The text of your notification.
UserId	string	The User, who shall be notified. If empty the whole organization will be notified.

 

SendNotificationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary