Sociabble (Preview)

Reference

Sociabble delivers top of the line enterprise social media solutions for employee advocacy, social selling, internal communication and Employee Engagement. Employees are better informed, improve their digital footprint.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	Sociabble Support
URL	https://www.sociabble.com
Email	support@sociabble.com

Connector Metadata
Publisher	Sociabble
Website	https://www.sociabble.com
Privacy policy	https://www.sociabble.com/fr/privacy-policy/
Categories	Website

Sociabble connector allows you to access data and perform action inside Sociabble. You can easily integrate it inside Power Automate to create content, reward users on the plateform etc.

Prerequisites

In order to use the connector, you need to have a subscription to Sociabble to acquire an API Key. See https://www.sociabble.com for details.

How to get credentials

Once you have access to your Sociabble plateform, you need to go to the admin part then API. On this page, you can see all the product API keys that you have access to.

Get started with your connector

During a content creation scenario, you should use the content product API key. During a gamification scenario such as assigning a badge or a custom action, you should use the gamification product API key.

Creating a connection

The connector supports the following authentication types:


Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
API Key	securestring	Sociabble Subscription Key	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Assign a badge to a user	Assign a badge to a user - Sociabble Basic
Assign a custom action to a user	Assign a custom action to a user - Sociabble Basic
Create a call to action that informs user for an event	Create a call to action that informs user for an event - Sociabble Basic
Create a call to action that suggests users to create content	Create a call to action that suggests users to create content - Sociabble Basic
Create a call to action that suggests users to install mobile apps	Create a call to action that suggests users to install mobile apps. - Sociabble Basic
Create a call to action that suggests users to invite other users	Create a call to action that suggests users to invite other users. - Sociabble Basic
Create an external content	Create an external content - Sociabble Basic
Create an internal news	Create an internal news - Sociabble Basic
Get all audiences	Get all audiences - Sociabble Basic
Get all badges	Get all badges - Sociabble Basic
Get all categories	Get all categories - Sociabble Basic
Get badge levels	Get badge levels - Sociabble Basic
Get channels	Get channels - Sociabble Basic
Get Media Drive folders	Get Media Drive folders - Sociabble Standard
Get Media Drive folders (deprecated) [DEPRECATED]	Get Media Drive folders (deprecated). - Sociabble Standard
Send an alert to an audience or a user	Send an alert to an audience or a user - Sociabble Standard
Upload a file to a Media Drive folder [DEPRECATED]	Upload a file to a Media Drive folder - Sociabble Standard
Upload a media (deprecated) [DEPRECATED]	Upload a media (media or mediaUrl in form-data) to use during the creation of an internal news (deprecated) - Sociabble Basic
Upload a Media From a File	Upload a media from a file to use during the creation of a content - Sociabble Basic
Upload a Media From a File Into a Media Drive's folder	Upload a Media From a File Into a Media Drive's folder and to use during the creation of a content - Sociabble Standard
Upload a Media From an URL	Upload a media from an URL to use during the creation of a content - Sociabble Basic
Upload a Media From an URL Into a Media Drive's folder	Upload a Media From an URL Into a Media Drive's folder and to use during the creation of a content - Sociabble Standard

Assign a badge to a user

Operation ID:: AssignBadgeToUser

Assign a badge to a user - Sociabble Basic

Parameters

Name	Key	Required	Type	Description
Username	username	True	string	The username of the user
Badge	badgeId	True	string	The badge to be assigned
Level	level	True	integer	The badge level to be assigned

Assign a custom action to a user

Operation ID:: AssignCustomActionToUser

Assign a custom action to a user - Sociabble Basic

Parameters

Name	Key	Required	Type	Description
Username	username	True	string	The username of the user
Is engaging ?	isEngaging		boolean	If the custom action should be considered as engaging, choose yes
Is internal ?	isInternal		boolean	If the custom action should be considered as an internal action, choose yes
Points	points		integer	The number of points earned by the user
Language	language	True	string	The language of the content.
Is the default language?	isDefault	True	boolean	If this language is the default, choose yes
Title	title	True	string	Write a title for the custom action
Description	description		string	Write a small description for the custom action
Notification	notificationText	True	string	Write a small text to be sent as a notification to the user

Create a call to action that informs user for an event

Operation ID:: CtaEventCreation

Create a call to action that informs user for an event - Sociabble Basic

Parameters

Name	Key	Required	Type	Description
Channel	channelIds	True	array of string
Audience Id	audienceId		string	The unique identifier of the audience
Category	categoryIds		array of string
Website link	link		string	The link pointing to an external source
Bonus awarded	awardedBonus		integer	The number of points that a user can earn by clicking the call to action
Language	language	True	string	The language of the content.
Is default language?	isDefault	True	boolean	If the content language should be the default, choose yes
Header text	headerText		string	The text of the header of the call to action
Title	title	True	string	The title of the call to action
Summary	summary		string	The summary of the call to action
Button text	buttonText	True	string	The text of the button
Set your image	mediaId		uuid	The unique identifier of the previously uploaded media that should be linked to the content
Header foreground color	headerForegroundColor		string	The foreground color of the header
Header background color	headerBackgroundColor		string	The background color of the header
Title foreground color	titleForegroundColor		string	The foreground color of the title
Summary foreground color	summaryForegroundColor		string	The foreground color of the summary
Background color	backgroundColor		string	The background color of the call to action
Button background color	buttonForegroundColor		string	The foreground color of the button
Button background color	buttonBackgroundColor		string	The foreground color of the button
Should display title ?	shouldDisplayTitle		boolean	This indicates whether the title should be visible or not
Should display button ?	shouldDisplayButton		boolean	This indicates whether the button should be visible or not
Publication start date	publicationStartDate		date-time	The date at which the content should be displayed
Publication end date	publicationEndDate		date-time	The date at which the content should not be displayed anymore
My News Display	myNewsDisplay		string	Define the behavior regarding the display of a content in "My News"
Should pin at the top of My News ?	shouldPinTopOfMyNews		boolean	If you want the content to be pinned at the top of "My News", choose yes
Start date pin at the top of My News	pinOfMyNewsStartDate		date-time	The date at which you want the content to be pinned at the top of "My News"
End date pin at the top of My News	pinOfMyNewsEndDate		date-time	The date at which you want the content to be unpinned from "My News"
Should pin at the top of selected channels ?	shouldPinTopOfSelectedChannels		boolean	If you want the content to be pinned at the top of the selected channels, choose yes
Start date pin at the top of selected channels	pinTopOfSelectedChannelsStartDate		date-time	The date at which you want the content to be pinned at the top of the selected channels
End date pin at the top of selected channels	pinTopOfSelectedChannelsEndDate		date-time	The date at which you want the content to be unpinned from selected channels

Returns

Body: CtaEventContent

Create a call to action that suggests users to create content

Operation ID:: CtaSuggestContentCreation

Create a call to action that suggests users to create content - Sociabble Basic

Parameters

Name	Key	Required	Type	Description
Channel	channelIds	True	array of string
Category	categoryIds		array of string
Audience Id	audienceId		string	The unique identifier of the audience
Publication start date	publicationStartDate		date-time	The date at which the content should be displayed
Publication end date	publicationEndDate		date-time	The date at which the content should not be displayed anymore
My News Display	myNewsDisplay		string	Define the behavior regarding the display of a content in "My News"
Should pin at the top of My News ?	shouldPinTopOfMyNews		boolean	If you want the content to be pinned at the top of "My News", choose yes
Start date pin at the top of My News	pinOfMyNewsStartDate		date-time	The date at which you want the content to be pinned at the top of "My News"
End date pin at the top of My News	pinOfMyNewsEndDate		date-time	The date at which you want the content to be unpinned from "My News"
Should pin at the top of selected channels ?	shouldPinTopOfSelectedChannels		boolean	If you want the content to be pinned at the top of the selected channels, choose yes
Start date pin at the top of selected channels	pinTopOfSelectedChannelsStartDate		date-time	The date at which you want the content to be pinned at the top of the selected channels
End date pin at the top of selected channels	pinTopOfSelectedChannelsEndDate		date-time	The date at which you want the content to be unpinned from selected channels
Language	language	True	string	The language of the content.
Is default language?	isDefault	True	boolean	If the content language should be the default, choose yes
Title	title	True	string	The title of the call to action
Summary	summary		string	The summary of the call to action
Set your image	mediaId		uuid	The unique identifier of the previously uploaded media that should be linked to the content
Title/Summary foreground color	titleForegroundColor		string	The foreground color of the title
Background color	backgroundColor		string	The background color of the call to action

Returns

Body: CtaSuggestContent

Create a call to action that suggests users to install mobile apps

Operation ID:: CtaMobileContentCreation

Create a call to action that suggests users to install mobile apps. - Sociabble Basic

Parameters

Name	Key	Required	Type	Description
Channel	channelIds	True	array of string
Category	categoryIds		array of string
Audience Id	audienceId		string	The unique identifier of the audience
Publication start date	publicationStartDate		date-time	The date at which the content should be displayed
Publication end date	publicationEndDate		date-time	The date at which the content should not be displayed anymore
My News Display	myNewsDisplay		string	Define the behavior regarding the display of a content in "My News"
Should pin at the top of My News ?	shouldPinTopOfMyNews		boolean	If you want the content to be pinned at the top of "My News", choose yes
Start date pin at the top of My News	pinOfMyNewsStartDate		date-time	The date at which you want the content to be pinned at the top of "My News"
End date pin at the top of My News	pinOfMyNewsEndDate		date-time	The date at which you want the content to be unpinned from "My News"
Should pin at the top of selected channels ?	shouldPinTopOfSelectedChannels		boolean	If you want the content to be pinned at the top of the selected channels, choose yes
Start date pin at the top of selected channels	pinTopOfSelectedChannelsStartDate		date-time	The date at which you want the content to be pinned at the top of the selected channels
End date pin at the top of selected channels	pinTopOfSelectedChannelsEndDate		date-time	The date at which you want the content to be unpinned from selected channels
Language	language	True	string	The language of the content.
Is default language?	isDefault	True	boolean	If the content language should be the default, choose yes
Title	title	True	string	The title of the call to action
Summary	summary		string	The summary of the call to action
Set your image	mediaId		uuid	The unique identifier of the previously uploaded media that should be linked to the content
Title/Summary foreground color	titleForegroundColor		string	The foreground color of the title
Background color	backgroundColor		string	The background color of the call to action

Returns

Body: CtaMobileContent

Create a call to action that suggests users to invite other users

Operation ID:: CtaInvitationContentCreation

Create a call to action that suggests users to invite other users. - Sociabble Basic

Parameters

Name	Key	Required	Type	Description
Channel	channelIds	True	array of string
Category	categoryIds		array of string
Audience Id	audienceId		string	The unique identifier of the audience
Publication start date	publicationStartDate		date-time	The date at which the content should be displayed
Publication end date	publicationEndDate		date-time	The date at which the content should not be displayed anymore
My News Display	myNewsDisplay		string	Define the behavior regarding the display of a content in "My News"
Should pin at the top of My News ?	shouldPinTopOfMyNews		boolean	If you want the content to be pinned at the top of "My News", choose yes
Start date pin at the top of My News	pinOfMyNewsStartDate		date-time	The date at which you want the content to be pinned at the top of "My News"
End date pin at the top of My News	pinOfMyNewsEndDate		date-time	The date at which you want the content to be unpinned from "My News"
Should pin at the top of selected channels ?	shouldPinTopOfSelectedChannels		boolean	If you want the content to be pinned at the top of the selected channels, choose yes
Start date pin at the top of selected channels	pinTopOfSelectedChannelsStartDate		date-time	The date at which you want the content to be pinned at the top of the selected channels
End date pin at the top of selected channels	pinTopOfSelectedChannelsEndDate		date-time	The date at which you want the content to be unpinned from selected channels
Language	language	True	string	The language of the content.
Is default language?	isDefault	True	boolean	If the content language should be the default, choose yes
Title	title	True	string	The title of the call to action
Summary	summary		string	The summary of the call to action
Set your image	mediaId		uuid	The unique identifier of the previously uploaded media that should be linked to the content
Title/Summary foreground color	titleForegroundColor		string	The foreground color of the title
Background color	backgroundColor		string	The background color of the call to action

Returns

Body: CtaInvitationContent

Create an external content

Operation ID:: CreateExternalContent

Create an external content - Sociabble Basic

Parameters

Name	Key	Required	Type	Description
Channel	channelIds	True	array of string
Category	categoryIds		array of string
Audience Id	audienceId		string	The unique identifier of the audience
Publication start date	publicationStartDate		date-time	The date at which the content should be displayed
Publication end date	publicationEndDate		date-time	The date at which the content should not be displayed anymore
My News Display	myNewsDisplay		string	Define the behavior regarding the display of a content in "My News"
Should pin at the top of My News ?	shouldPinTopOfMyNews		boolean	If you want the content to be pinned at the top of "My News", choose yes
Start date pin at the top of My News	pinOfMyNewsStartDate		date-time	The date at which you want the content to be pinned at the top of "My News"
End date pin at the top of My News	pinOfMyNewsEndDate		date-time	The date at which you want the content to be unpinned from "My News"
Should pin at the top of selected channels ?	shouldPinTopOfSelectedChannels		boolean	If you want the content to be pinned at the top of the selected channels, choose yes
Start date pin at the top of selected channels	pinTopOfSelectedChannelsStartDate		date-time	The date at which you want the content to be pinned at the top of the selected channels
End date pin at the top of selected channels	pinTopOfSelectedChannelsEndDate		date-time	The date at which you want the content to be unpinned from selected channels
Language	language	True	string	The language of the content.
Is the language default ?	isDefault	True	boolean	If the language should be considered as default, choose yes
Title	title	True	string	The title
Description	description	True	string	The content
Proposed comment	proposedCommentForSharing		string	A comment that will be proposed to users when sharing
Media Id	mediaId		string	The unique identifier of the previously uploaded media that should be linked to the content
Content URL	contentUrl	True	string	The link pointing to an external source
Is content shareable ?	isShareable		boolean	If the content can be shared on external networks, choose yes
Is an official content ?	isOfficialContent		boolean	If the content should be considered as official, choose yes
Are comments authorized ?	areCommentsAuthorized		boolean	If the content can be commented, choose yes
Should notify users ?	shouldNotifyUsers		boolean	If a notification should be sent to users when content is available, choose yes
Is a must read content ?	isMustReadContent		boolean	If you want users explicitely mark the content as read, choose yes

Returns

Body: ExternalContent

Create an internal news

Operation ID:: CreateInternalNews

Create an internal news - Sociabble Basic

Parameters

Name	Key	Required	Type	Description
Channel	channelIds	True	array of string
Category	categoryIds		array of string
Audience Id	audienceId		string	The unique identifier of the audience
Publication start date	publicationStartDate		date-time	The date at which the content should be displayed
Publication end date	publicationEndDate		date-time	The date at which the content should not be displayed anymore
My News Display	myNewsDisplay		string	Define the behavior regarding the display of a content in "My News"
Should pin at the top of My News ?	shouldPinTopOfMyNews		boolean	If you want the content to be pinned at the top of "My News", choose yes
Start date pin at the top of My News	pinOfMyNewsStartDate		date-time	The date at which you want the content to be pinned at the top of "My News"
End date pin at the top of My News	pinOfMyNewsEndDate		date-time	The date at which you want the content to be unpinned from "My News"
Should pin at the top of selected channels ?	shouldPinTopOfSelectedChannels		boolean	If you want the content to be pinned at the top of the selected channels, choose yes
Start date pin at the top of selected channels	pinTopOfSelectedChannelsStartDate		date-time	The date at which you want the content to be pinned at the top of the selected channels
End date pin at the top of selected channels	pinTopOfSelectedChannelsEndDate		date-time	The date at which you want the content to be unpinned from selected channels
Language	language	True	string	The language of the content.
Is the default language?	isDefault	True	boolean	If the language should be considered as default, choose yes
Title	title	True	string	The title
Summary	summary	True	string	A short summary of the content
Description	description	True	string	The content
mediaIds	mediaIds		array of string	An array containing the unique identifiers of the previously uploaded medias that are linked to the content
Are comments authorized ?	areCommentsAuthorized		boolean	If the content can be commented, choose yes
Should notify users ?	shouldNotifyUsers		boolean	If a notification should be sent to users when content is available, choose yes
Is must read ?	isMustReadContent		boolean	If you want users explicitely mark the content as read, choose yes

Returns

Represents an internal news

Body: InternalContent

Get all audiences

Operation ID:: GetAudiences

Get all audiences - Sociabble Basic

Returns

Name	Path	Type	Description
		array of object
Id	id	string	id
Name	name	string	name

Get all badges

Operation ID:: GetAllBadges

Get all badges - Sociabble Basic

Returns

Name	Path	Type	Description
		array of object
Id	id	string	id
Name	name	string	name

Get all categories

Operation ID:: GetCategories

Get all categories - Sociabble Basic

Returns

Name	Path	Type	Description
		array of object
Id	id	string	The unique identifier of the category
Name	name	string	The name of the category
Background color	backgroundColor	string	The background color of the category
Text color	textColor	string	The text color of the category
Shoud fill background	shouldFillBackground	boolean	If the background color should fill all the background, the value is true. If the background color should be used in border only mode, the value is false

Get badge levels

Operation ID:: GetBadgeLevels

Get badge levels - Sociabble Basic

Parameters

Name	Key	Required	Type	Description
Badge Id	badgeId	True	string	A unique identifier of a badge

Returns

Name	Path	Type	Description
		array of object
Badge Id	badgeId	string	badgeId
Level	level	integer	level
Name	name	string	name

Get channels

Operation ID:: GetChannels

Get channels - Sociabble Basic

Returns

Name	Path	Type	Description
		array of object
Id	id	string	id
Name	name	string	name

Get Media Drive folders

Operation ID:: GetMediaDriveFolders

Get Media Drive folders - Sociabble Standard

Parameters

Name	Key	Required	Type	Description
Culture	culture		string	The language in which the labels are returned

Returns

Body: GetFoldersResponse

Get Media Drive folders (deprecated) [DEPRECATED]

Operation ID:: GetMediaFolders

Get Media Drive folders (deprecated). - Sociabble Standard

Parameters

Name	Key	Required	Type	Description
Culture	culture		string	The culture in which you want the default folders to be returned

Returns

Name	Path	Type	Description
folders	folders	array of object	folders
Id	folders.id	string	The unique identifier of the folder
Name	folders.name	string	The name of the folder

Send an alert to an audience or a user

Operation ID:: SendAlertRequest

Send an alert to an audience or a user - Sociabble Standard

Parameters

Name	Key	Required	Type	Description
Alert Text	alertText	True	string	The text for the alert
Alert Title	alertTitle	True	string	The title for the alert
Start date	startDate		date-time	The date to which the alert is going to be sent
End date	endDate		date-time	The date to which the alert should not be visible anymore
Audience	audienceId		string	The unique identifier of the audience if you wand send the alert to many users
Username	username		string	The username of the user if you want send the alert to one user
Is mandatory ?	isMandatory		boolean	If you want users confirm that they read the alert
Send SMS ?	sendSMS		boolean	If you want send an sms to users.This parameter is optional and only accessible for Premium subscriptions

Upload a file to a Media Drive folder [DEPRECATED]

Operation ID:: UploadFileFolder

Upload a file to a Media Drive folder - Sociabble Standard

Parameters

Name	Key	Required	Type	Description
Media	media	True	file	The media to be uploaded
Folder,	folderId	True	string	Choose a folder

Returns

Upload a media (deprecated) [DEPRECATED]

Operation ID:: UploadMedia

Upload a media (media or mediaUrl in form-data) to use during the creation of an internal news (deprecated) - Sociabble Basic

Parameters

Name	Key	Required	Type	Description
Media Visibility	mediaVisibility	True	string	This represents the visibility of a media. If the media is not intended to be publicly visible (for exemple linked to an internal news that can't be shared) the value should be private
Media URL	mediaUrl		string	The url of the media to upload. You can either specify media or mediaUrl but not both
Folder Id	folderId		string	The unique identifier of the media drive folder in which the media should be uploaded into. This parameter is optional and only accessible for Standard subscriptions
Media	media		file	The media to upload. You can either specify media or mediaUrl but not both

Returns

Body: UploadMediaResponse

Upload a Media From a File

Operation ID:: UploadMediaByStream

Upload a media from a file to use during the creation of a content - Sociabble Basic

Parameters

Name	Key	Required	Type	Description
Media Visibility	mediaVisibility	True	string	This represents the visibility of a media. If the media is not intended to be publicly visible (for exemple linked to an internal news that can't be shared) the value should be private
Media	media	True	file	The media stream to upload.

Returns

Body: UploadMediaResponse

Upload a Media From a File Into a Media Drive's folder

Operation ID:: UploadMediaByStreamByFolder

Upload a Media From a File Into a Media Drive's folder and to use during the creation of a content - Sociabble Standard

Parameters

Name	Key	Required	Type	Description
Media Visibility	mediaVisibility	True	string	This represents the visibility of a media. If the media is not intended to be publicly visible (for exemple linked to an internal news that can't be shared) the value should be private
Folder Id	folderId	True	string	The unique identifier of the media drive folder in which the media should be uploaded into. This parameter is optional and only accessible for Standard subscriptions
Media	media	True	file	The media stream to upload.

Returns

Body: UploadMediaResponse

Upload a Media From an URL

Operation ID:: UploadMediaByUrl

Upload a media from an URL to use during the creation of a content - Sociabble Basic

Parameters

Name	Key	Required	Type	Description
Media Visibility	mediaVisibility	True	string	This represents the visibility of a media. If the media is not intended to be publicly visible (for exemple linked to an internal news that can't be shared) the value should be private
Media URL	mediaUrl	True	string	The url of the media to upload.

Returns

Body: UploadMediaResponse

Upload a Media From an URL Into a Media Drive's folder

Operation ID:: UploadMediaByUrlByFolder

Upload a Media From an URL Into a Media Drive's folder and to use during the creation of a content - Sociabble Standard

Parameters

Name	Key	Required	Type	Description
Media Visibility	mediaVisibility	True	string	This represents the visibility of a media. If the media is not intended to be publicly visible (for exemple linked to an internal news that can't be shared) the value should be private
Folder Id	folderId	True	string	The unique identifier of the media drive folder in which the media should be uploaded into. This parameter is optional and only accessible for Standard subscriptions
Media URL	mediaUrl	True	string	The url of the media to upload.

Returns

Body: UploadMediaResponse

Definitions

LanguageBehavior

The language of the content.

Language: string

ContentTypeDiscriminator

Represents the type of the content

Members:

None - The type is undefined, this can happen when a new type of content was introduced but not supported yet
InternalNews - This represents an internal news
Quiz - This represents a quiz
Survey - This represents a survey
ContentForSharing - This represents a content for sharing purpose with multiple content
Cta - This represents a call to action
Live - This represents a live video
SocialNetworkContent - This represents a content fetched from social networks
AdminExternalContent - This represents a content fetched from a web link created by an admin
PersonalisedTile - This represents a personalised (html) tile
Poll - This represents a survey created by a user
UserContent - This represents a content created by a user
SupportMyCause - This represents a project support my cause

Represents the type of the content

Members:

None - The type is undefined, this can happen when a new type of content was introduced but not supported yet
InternalNews - This represents an internal news
Quiz - This represents a quiz
Survey - This represents a survey
ContentForSharing - This represents a content for sharing purpose with multiple content
Cta - This represents a call to action
Live - This represents a live video
SocialNetworkContent - This represents a content fetched from social networks
AdminExternalContent - This represents a content fetched from a web link created by an admin
PersonalisedTile - This represents a personalised (html) tile
Poll - This represents a survey created by a user
UserContent - This represents a content created by a user
SupportMyCause - This represents a project support my cause

: string

CtaContentTypeDiscriminator

Represents the type of a call to action content

Members:

None - The type is undefined, it should not be used
SuggestContent - This represents a call to action that suggests users to create content
Mobile - This represents a call to action that suggests users to install mobile apps
Invitation - This represents a call to action that suggests users to invite other users
Event - This represents a call to action that suggests users to check out an external link (exemple : an external event)

Represents the type of a call to action content

Members:

None - The type is undefined, it should not be used
SuggestContent - This represents a call to action that suggests users to create content
Mobile - This represents a call to action that suggests users to install mobile apps
Invitation - This represents a call to action that suggests users to invite other users
Event - This represents a call to action that suggests users to check out an external link (exemple : an external event)

: string

ContentCategory

Name	Path	Type	Description
Category Id	id	string	The unique identifier of the category
Category name	name	string	The name of the category
Category background color	backgroundColor	string	The background color of the category
Category text color	textColor	string	The text color of the category
Should fill background	shouldFillBackground	boolean	If the background color should fill all the background, the value is true. If the background color should be used in border only mode, the value is false

ContentChannel

Represents a channel associated with a content

Name	Path	Type	Description
Channel Id	id	string	The unique identifier of the channel
Channel name	name	string	The name of the channel
Channel image	image	string	The image url of the channel
Channel background color	backgroundColor	string	The background color of the channel in case there is no image

ContentImage

Represents an image associated with a content

Name	Path	Type	Description
Content image Id	id	string	The unique identifier for the image
Content image short	short	string	A short hash that can be used to ask transformation on the image
Content image url	url	string	The image url
Content image order	order	integer	If there are multiple image associated with the content, an order can be specified

InternalContent

Represents an internal news

Name	Path	Type	Description
discriminator	discriminator	ContentTypeDiscriminator	Represents the type of the content Members: None - The type is undefined, this can happen when a new type of content was introduced but not supported yet InternalNews - This represents an internal news Quiz - This represents a quiz Survey - This represents a survey ContentForSharing - This represents a content for sharing purpose with multiple content Cta - This represents a call to action Live - This represents a live video SocialNetworkContent - This represents a content fetched from social networks AdminExternalContent - This represents a content fetched from a web link created by an admin PersonalisedTile - This represents a personalised (html) tile Poll - This represents a survey created by a user UserContent - This represents a content created by a user SupportMyCause - This represents a project support my cause
Id	id	string	The unique identifier of the content
Publication date	date	date-time	The publication date for the content
Internal URL	internalUrl	string	The url to view the content
channelIds	channelIds	array of string	An array containing all unique identifiers of the channels where the content appears. Deprecated: The property Channels should be used instead
Channels	channels	array of ContentChannel	An array containing all channels where the content appears
Audience Id	audienceId	string	The unique identifier of the audience Deprecated: This property will always be empty or null
Categories	categories	array of ContentCategory	The categories associated with the content
Like number	likeNumber	integer	The number of times users clicked "like"
Comment number	commentNumber	integer	The number of times users wrote a comment
Click number	clickNumber	integer	The number of times users clicked on the content
Content has been read	hasBeenRead	boolean	If the content has been already read the value is yes
Contents	contents	array of LocalizedInternalContent	An array containing the content in different languages

ExternalContent

Name	Path	Type	Description
discriminator	discriminator	ContentTypeDiscriminator	Represents the type of the content Members: None - The type is undefined, this can happen when a new type of content was introduced but not supported yet InternalNews - This represents an internal news Quiz - This represents a quiz Survey - This represents a survey ContentForSharing - This represents a content for sharing purpose with multiple content Cta - This represents a call to action Live - This represents a live video SocialNetworkContent - This represents a content fetched from social networks AdminExternalContent - This represents a content fetched from a web link created by an admin PersonalisedTile - This represents a personalised (html) tile Poll - This represents a survey created by a user UserContent - This represents a content created by a user SupportMyCause - This represents a project support my cause
Id	id	string	The unique identifier of the content
Publication date	date	date-time	The publication date for the content
Internal URL	internalUrl	string	The url to view the content
channelIds	channelIds	array of string	An array containing all unique identifiers of the channels where the content appears. Deprecated: The property Channels should be used instead
Channels	channels	array of ContentChannel	An array containing all channels where the content appears
Audience Id	audienceId	string	The unique identifier of the audience. Deprecated: This property will always be empty or null
Categories	categories	array of ContentCategory	The categories associated with the content
Like number	likeNumber	integer	The number of times users clicked "like"
Comment number	commentNumber	integer	The number of times users wrote a comment
Click number	clickNumber	integer	The number of times users clicked on the content
Content has been read	hasBeenRead	boolean	If the content has been already read the value is yes
Contents	contents	array of LocalizedExternalContent	An array containing the content in different languages
Content url	contentUrl	string	The link pointing to an external source
Is content shareable ?	isShareable	boolean	If the content can be shared on external networks, choose yes
Is content official ?	isOfficialContent	boolean	If the content should be considered as official, choose yes
Are comments authorized ?	areCommentsAuthorized	boolean	If the content can be commented, choose yes

LocalizedExternalContent

Name	Path	Type	Description
Language	language	LanguageBehavior	The language of the content.
Is the default language?	isDefault	boolean	If the language should be considered as default, choose yes
Title	title	string	The title
Description	description	string	The content
Proposed comment	proposedCommentForSharing	string	A comment that will be proposed to users when sharing
Media Id	mediaId	string	The unique identifier of the previously uploaded media that should be linked to the content
image	image	ContentImage	Represents an image associated with a content

LocalizedInternalContent

Name	Path	Type	Description
Language	language	string	The language of the content
Is the default language?	isDefault	boolean	If the language should be considered as default, choose yes
Title	title	string	The title
Summary	summary	string	A short summary of the content
Description	description	string	The content
mediaIds	mediaIds	array of string	An array containing the unique identifiers of the previously uploaded medias that are linked to the content. Deprecated: The property Medias should be used instead
Medias	medias	array of ContentImage	The images of the content

LocalizedBaseCtaContent

Name	Path	Type	Description
language	language	string	The language of the call to action
isDefault	isDefault	boolean	If the content language is the default, the value is true
title	title	string	The title of the call to action
summary	summary	string	The summary of the call to action
image	image	ContentImage	Represents an image associated with a content
titleForegroundColor	titleForegroundColor	string	The foreground color of the title
backgroundColor	backgroundColor	string	The background color of the call to action

LocalizedCtaEventContent

Name	Path	Type	Description
language	language	string	The language of the call to action
isDefault	isDefault	boolean	If the content language is the default, the value is true
title	title	string	The title of the call to action
summary	summary	string	The summary of the call to action
image	image	ContentImage	Represents an image associated with a content
titleForegroundColor	titleForegroundColor	string	The foreground color of the title
backgroundColor	backgroundColor	string	The background color of the call to action
headerText	headerText	string	The text of the header
buttonText	buttonText	string	The text of the button
headerForegroundColor	headerForegroundColor	string	The foreground color of the header
headerBackgroundColor	headerBackgroundColor	string	The background color of the header
buttonForegroundColor	buttonForegroundColor	string	The foreground color of the button
buttonBackgroundColor	buttonBackgroundColor	string	The background color of the button
summaryForegroundColor	summaryForegroundColor	string	The foreground color of the summary

GetFoldersResponse

Name	Path	Type	Description
folders	folders	array of MediaFolder	An array of media folders

MediaFolder

Name	Path	Type	Description
Folder id	id	string	The unique identifier of the folder
Folder name	name	string	The name of the folder
Can upload into folder	canUploadInto	boolean	If you can upload files in this folder, the value is yes
Can Upload into folder	isGeneratedFolder	boolean	If the folder is generated by the system, the value is yes

UploadMediaResponse

Name	Path	Type	Description
Media Id	mediaId	string	The unique identifier of the media
Media url	url	string	The media url

CtaSuggestContent

Name	Path	Type	Description
ctaDiscriminator	ctaDiscriminator	CtaContentTypeDiscriminator	Represents the type of a call to action content Members: None - The type is undefined, it should not be used SuggestContent - This represents a call to action that suggests users to create content Mobile - This represents a call to action that suggests users to install mobile apps Invitation - This represents a call to action that suggests users to invite other users Event - This represents a call to action that suggests users to check out an external link (exemple : an external event)
discriminator	discriminator	ContentTypeDiscriminator	Represents the type of the content Members: None - The type is undefined, this can happen when a new type of content was introduced but not supported yet InternalNews - This represents an internal news Quiz - This represents a quiz Survey - This represents a survey ContentForSharing - This represents a content for sharing purpose with multiple content Cta - This represents a call to action Live - This represents a live video SocialNetworkContent - This represents a content fetched from social networks AdminExternalContent - This represents a content fetched from a web link created by an admin PersonalisedTile - This represents a personalised (html) tile Poll - This represents a survey created by a user UserContent - This represents a content created by a user SupportMyCause - This represents a project support my cause
id	id	uuid	The unique identifier of the content
date	date	date-time	The publication date for the content
internalUrl	internalUrl	string	The url to view the content
channelIds	channelIds	array of uuid	An array containing all unique identifiers of the channels where the content appears Deprecated: The property Channels should be used instead
channels	channels	array of ContentChannel	An array containing all channels where the content appears
audienceId	audienceId	uuid	The unique identifier of the audience Deprecated: This property will always be empty or null
categories	categories	array of ContentCategory	The categories associated with the content
likeNumber	likeNumber	integer	The number of times users clicked "like"
commentNumber	commentNumber	integer	The number of times users wrote a comment
clickNumber	clickNumber	integer	The number of times users clicked on the content
hasBeenRead	hasBeenRead	boolean	If the content has been already read the value is yes
contents	contents	array of LocalizedBaseCtaContent	An array containing the call to action in different languages

CtaInvitationContent

Name	Path	Type	Description
ctaDiscriminator	ctaDiscriminator	CtaContentTypeDiscriminator	Represents the type of a call to action content Members: None - The type is undefined, it should not be used SuggestContent - This represents a call to action that suggests users to create content Mobile - This represents a call to action that suggests users to install mobile apps Invitation - This represents a call to action that suggests users to invite other users Event - This represents a call to action that suggests users to check out an external link (exemple : an external event)
discriminator	discriminator	ContentTypeDiscriminator	Represents the type of the content Members: None - The type is undefined, this can happen when a new type of content was introduced but not supported yet InternalNews - This represents an internal news Quiz - This represents a quiz Survey - This represents a survey ContentForSharing - This represents a content for sharing purpose with multiple content Cta - This represents a call to action Live - This represents a live video SocialNetworkContent - This represents a content fetched from social networks AdminExternalContent - This represents a content fetched from a web link created by an admin PersonalisedTile - This represents a personalised (html) tile Poll - This represents a survey created by a user UserContent - This represents a content created by a user SupportMyCause - This represents a project support my cause
id	id	uuid	The unique identifier of the content
date	date	date-time	The publication date for the content
internalUrl	internalUrl	string	The url to view the content
channelIds	channelIds	array of uuid	An array containing all unique identifiers of the channels where the content appears Deprecated: The property Channels should be used instead
channels	channels	array of ContentChannel	An array containing all channels where the content appears
audienceId	audienceId	uuid	The unique identifier of the audience Deprecated: This property will always be empty or null
categories	categories	array of ContentCategory	The categories associated with the content
likeNumber	likeNumber	integer	The number of times users clicked "like"
commentNumber	commentNumber	integer	The number of times users wrote a comment
clickNumber	clickNumber	integer	The number of times users clicked on the content
hasBeenRead	hasBeenRead	boolean	If the content has been already read the value is yes
contents	contents	array of LocalizedBaseCtaContent	An array containing the call to action in different languages

CtaMobileContent

Name	Path	Type	Description
ctaDiscriminator	ctaDiscriminator	CtaContentTypeDiscriminator	Represents the type of a call to action content Members: None - The type is undefined, it should not be used SuggestContent - This represents a call to action that suggests users to create content Mobile - This represents a call to action that suggests users to install mobile apps Invitation - This represents a call to action that suggests users to invite other users Event - This represents a call to action that suggests users to check out an external link (exemple : an external event)
discriminator	discriminator	ContentTypeDiscriminator	Represents the type of the content Members: None - The type is undefined, this can happen when a new type of content was introduced but not supported yet InternalNews - This represents an internal news Quiz - This represents a quiz Survey - This represents a survey ContentForSharing - This represents a content for sharing purpose with multiple content Cta - This represents a call to action Live - This represents a live video SocialNetworkContent - This represents a content fetched from social networks AdminExternalContent - This represents a content fetched from a web link created by an admin PersonalisedTile - This represents a personalised (html) tile Poll - This represents a survey created by a user UserContent - This represents a content created by a user SupportMyCause - This represents a project support my cause
id	id	uuid	The unique identifier of the content
date	date	date-time	The publication date for the content
internalUrl	internalUrl	string	The url to view the content
channelIds	channelIds	array of uuid	An array containing all unique identifiers of the channels where the content appears Deprecated: The property Channels should be used instead
channels	channels	array of ContentChannel	An array containing all channels where the content appears
audienceId	audienceId	uuid	The unique identifier of the audience Deprecated: This property will always be empty or null
categories	categories	array of ContentCategory	The categories associated with the content
likeNumber	likeNumber	integer	The number of times users clicked "like"
commentNumber	commentNumber	integer	The number of times users wrote a comment
clickNumber	clickNumber	integer	The number of times users clicked on the content
hasBeenRead	hasBeenRead	boolean	If the content has been already read the value is yes
contents	contents	array of LocalizedBaseCtaContent	An array containing the call to action in different languages

CtaEventContent

Name	Path	Type	Description
discriminator	discriminator	ContentTypeDiscriminator	Represents the type of the content Members: None - The type is undefined, this can happen when a new type of content was introduced but not supported yet InternalNews - This represents an internal news Quiz - This represents a quiz Survey - This represents a survey ContentForSharing - This represents a content for sharing purpose with multiple content Cta - This represents a call to action Live - This represents a live video SocialNetworkContent - This represents a content fetched from social networks AdminExternalContent - This represents a content fetched from a web link created by an admin PersonalisedTile - This represents a personalised (html) tile Poll - This represents a survey created by a user UserContent - This represents a content created by a user SupportMyCause - This represents a project support my cause
id	id	uuid	The unique identifier of the content
date	date	date-time	The publication date for the content
internalUrl	internalUrl	string	The url to view the content
channelIds	channelIds	array of uuid	An array containing all unique identifiers of the channels where the content appears Deprecated: The property Channels should be used instead
channels	channels	array of ContentChannel	An array containing all channels where the content appears
audienceId	audienceId	uuid	The unique identifier of the audience Deprecated: This property will always be empty or null
categories	categories	array of ContentCategory	The categories associated with the content
likeNumber	likeNumber	integer	The number of times users clicked "like"
commentNumber	commentNumber	integer	The number of times users wrote a comment
clickNumber	clickNumber	integer	The number of times users clicked on the content
hasBeenRead	hasBeenRead	boolean	If the content has been already read the value is yes
awardedBonus	awardedBonus	integer	The number of points that a user can earn by clicking the call to action
link	link	string	The link pointing to an external source
shouldDisplayButton	shouldDisplayButton	boolean	This indicates whether the button should be visible or not
shouldDisplayTitle	shouldDisplayTitle	boolean	This indicates whether the title should be visible or not
ctaDiscriminator	ctaDiscriminator	CtaContentTypeDiscriminator	Represents the type of a call to action content Members: None - The type is undefined, it should not be used SuggestContent - This represents a call to action that suggests users to create content Mobile - This represents a call to action that suggests users to install mobile apps Invitation - This represents a call to action that suggests users to invite other users Event - This represents a call to action that suggests users to check out an external link (exemple : an external event)
contents	contents	array of LocalizedCtaEventContent	An array containing the call to action in different languages

Partilhar via

Sociabble (Preview)

Prerequisites

How to get credentials

Get started with your connector

Creating a connection

Default

Throttling Limits

Actions

Assign a badge to a user

Parameters

Assign a custom action to a user

Parameters

Create a call to action that informs user for an event

Parameters

Returns

Create a call to action that suggests users to create content

Parameters

Returns

Create a call to action that suggests users to install mobile apps

Parameters

Returns

Create a call to action that suggests users to invite other users

Parameters

Returns

Create an external content

Parameters

Returns

Create an internal news

Parameters

Returns

Get all audiences

Returns

Get all badges

Returns

Get all categories

Returns

Get badge levels

Parameters

Returns

Get channels

Returns

Get Media Drive folders

Parameters

Returns

Get Media Drive folders (deprecated) [DEPRECATED]

Parameters

Returns

Send an alert to an audience or a user

Parameters

Upload a file to a Media Drive folder [DEPRECATED]

Parameters

Returns

Upload a media (deprecated) [DEPRECATED]

Parameters

Returns

Upload a Media From a File

Parameters

Returns

Upload a Media From a File Into a Media Drive's folder

Parameters

Returns

Upload a Media From an URL

Parameters

Returns

Upload a Media From an URL Into a Media Drive's folder

Parameters

Returns

Definitions

LanguageBehavior

ContentTypeDiscriminator

CtaContentTypeDiscriminator

ContentCategory

ContentChannel

ContentImage

InternalContent

ExternalContent

LocalizedExternalContent

LocalizedInternalContent

LocalizedBaseCtaContent