Sociabble (Preview)
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 |
| 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 |
| Assign a custom action to a user |
Assign a custom action to a user |
| Create an external content |
Create an external content |
| Create an internal news |
Create an internal news |
| Get all badges |
Get all badges |
| Get all categories |
Get all categories |
| Get audiences |
Get audiences |
| Get badge levels |
Get badge levels |
| Get channels |
Get channels |
| Get Media Drive folders |
Get Media Drive folders |
| Get Media Drive folders [DEPRECATED] |
Get Media Drive folders |
| Upload a file to a Media Drive folder [DEPRECATED] |
Upload a file to a Media Drive folder |
| Upload a media |
Upload a media (media or mediaUrl in form-data) to use during the creation of an internal news |
Assign a badge to a user
Assign a badge to a user
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 |
Returns
Assign a custom action to a user
Assign a custom action to a user
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 |
|
|
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 |
|
language
|
language | True | string |
Language of the custom action |
|
is default ?
|
isDefault | boolean |
If this language is the default, choose yes |
Returns
Create an external content
Create an external content
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Channel
|
Channel | string |
Choose a channel that the content will be published to |
|
|
Category
|
Category | string |
Choose a category that the content will be tagged with |
|
|
Audience Id
|
audienceId | string |
The unique identifier of the audience |
|
|
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 |
|
|
My News Display
|
myNewsDisplay | string |
Define the behavior regarding the display of a content in "My News" |
|
|
Language
|
language | True | string |
The language of the content |
|
Is the language default ?
|
isDefault | 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 |
|
|
Date
|
date | date-time |
The publication date for the content. Deprecated: PublicationStartDate should be used instead |
|
|
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 |
|
|
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
Create an internal news
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Channel
|
Channel | string |
Choose a channel that the content will be published to |
|
|
Category
|
Category | string |
Choose a category that the content will be tagged with |
|
|
Audience Id
|
audienceId | string |
The unique identifier of the audience |
|
|
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 |
|
|
My News Display
|
myNewsDisplay | string |
Define the behavior regarding the display of a content in "My News" |
|
|
Language
|
language | True | string |
The language of the content. |
|
Is the language default ?
|
isDefault | 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 | string | ||
|
Date
|
date | date-time |
The publication date for the content. Deprecated: PublicationStartDate should be used instead |
|
|
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 |
|
|
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 badges
Get all badges
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Id
|
id | string |
id |
|
Name
|
name | string |
name |
Get all categories
Get all categories
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 audiences
Get audiences
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Id
|
id | string |
id |
|
Name
|
name | string |
name |
Get badge levels
Get badge levels
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
Get channels
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Id
|
id | string |
id |
|
Name
|
name | string |
name |
Get Media Drive folders
Get Media Drive folders
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]
Get Media Drive folders
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 |
Upload a file to a Media Drive folder [DEPRECATED]
Upload a file to a Media Drive folder
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
Upload a media (media or mediaUrl in form-data) to use during the creation of an internal news
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
Definitions
InternalContent
Represents an internal news
| Name | Path | Type | Description |
|---|---|---|---|
|
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 |
LocalizedInternalContent
| Name | Path | Type | Description |
|---|---|---|---|
|
Language
|
language | string |
The language of the content |
|
Is language default ?
|
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 |
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 |
ExternalContent
| Name | Path | Type | Description |
|---|---|---|---|
|
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 | string |
The language of the content |
|
Is language default ?
|
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 |
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 |
|
Is folder generated
|
isGeneratedFolder | boolean |
If the folder is generated by the system, the value is yes |
|
Can upload into folder
|
canUploadInto | boolean |
If you can upload files in this folder, 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 |
الملاحظات
إرسال الملاحظات وعرضها المتعلقة بـ