Dynamic Signal (Preview)

Dynamic Signal (Preview)

Dynamic Signal is an Employee Communication and Engagement Platform, trusted by organizations to connect, align and engage employees. Connect to Dynamic Signal to create and manage your posts and users.

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
Flow Premium All Flow regions except the following:
     -   US Government (GCC)
PowerApps Premium All PowerApps regions except the following:
     -   US Government (GCC)

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Creating a connection

To connect your account, you will need the following information:

Bearer Token
securestring
The Bearer Token for this api
Dynamic Signal URL
string
The URL where you access Dynamic Signal.

Actions

Add an image to a post via URL

Sets the post image via a URL.

Required Parameters

ID
uuid
The post ID, required: true
Url
string
The HTTP or HTTPS URL

Returns

A simple response indicating the action was carried out successfully

Add an image to a post via upload

Sets the post image via binary upload.

Required Parameters

ID
uuid
The post ID
File
binary
File to upload
Content-Type such as image/jpg, image/pjpeg, image/png, image/x-png, image/gif
string
Content-Type of uploaded file

Returns

A simple response indicating the action was carried out successfully

Create a post

Creates a post.

Required Parameters

Title
string
The title of the post

Optional Parameters

Description
string
The short description of the post
Tag Line
string
The tag line of the post
Content
string
The body of the post
Creator Comments
string
A message associated with the post
Perma Link
string
The external URL referenced by the post
Internal Discussions Enabled
boolean
Whether members are allowed to perform like action and add comments on posts internally
Member Video Url
string
The video URL referenced by the post
Post Type
string
The basic type of the post
Approval State
string
The approval state of the post. Defaults to the author's Review Status setting.
Display Mode
string
Indicates redirection of a post to an internal or external location
Sharable
boolean
Whether the VoiceStorm platform and widgets will allow for the post to be shared
Start Date
date-time
The date after which the post is available for viewing
End Date
date-time
The date the after which the post will no longer be available for viewing
Suggested Share Text
string
The suggested share text for the post
Short Suggested Share Text
string
The suggested share text for the post for short message providers
Share Points
integer
The number of points awarded when a user shares the post
Click Points
integer
The number of points awarded when someone clicks on a shared link to the post
Share With Images
boolean
Controls if posts shared to short message services (like Twitter) have images shared
Share Images Only
boolean
Controls if posts shared to certain services are treated as image/photo only updates
Name
string
The tag name
Language
string
The language of the post content
Documents
uuid
A list of documents IDs to attach to this post
Creator ID
integer
The user that is creating the post; This property is only available for server-authenticated requests at this time. All other posts are automatically set to the authenticated user.
Display Creator
boolean
Controls whether the creator information is to be displayed with the post or not; This property is only available for server-authenticated requests at this time.
Category IDs
integer
A list of category IDs that have been assigned to the post
Target IDs
integer
A list of target Ids that have been assigned to the post

Returns

A post

Get a post

Gets a specific post by ID

Required Parameters

ID
uuid
The post ID.; This is the unique identifier for the post.

Optional Parameters

User ID
integer
The user who is viewing the post. The logged in user will be used if no ID is specified

Returns

A post

Get a user by email

Retrieves a user by their email address

Required Parameters

Email
string
The user's email

Optional Parameters

Include
string
Specifies optional data to return with the user.

Returns

Get categories

Gets a list of categories that are visible to the authenticated user

Required Parameters

ID
uuid
The post ID, required: true
Url
string
The HTTP or HTTPS URL

Returns

Detailed information related to categories

Get divisions

Gets the list of divisions

Required Parameters

ID
uuid
The post ID, required: true
Url
string
The HTTP or HTTPS URL

Returns

The divisions defined in the system

Get post tags

Gets the post tags defined in the system

Required Parameters

ID
uuid
The post ID, required: true
Url
string
The HTTP or HTTPS URL

Returns

A list of post tags defined in the system

Get targets

Gets a list of the community's targets and target definitions

Required Parameters

ID
uuid
The post ID, required: true
Url
string
The HTTP or HTTPS URL

Returns

A list of target definitions and associated targets for the community.

Get user tags

Gets a list of user tags defined in the system

Required Parameters

ID
uuid
The post ID, required: true
Url
string
The HTTP or HTTPS URL

Returns

A list of user tags defined in the system

Manage posts

Allows server-authenticated calls to update properties for multiple posts in a single request

Optional Parameters

Post IDs
uuid
The posts being modified
Tags
string
A collection of tag names that can be applied to posts
Division IDs
integer
The division IDs to which the posts belong
Category IDs
integer
The category IDs to which the posts belong
Target IDs
integer
The target IDs to which the posts belong
Approval State
string
The Approval state for the posts (This is not affected by the DELETE requests)

Returns

A simple response indicating the action was carried out successfully

Preregister a user

Creates a new user in the preregistered state

Optional Parameters

Email
string
The user's email address
External Sso User ID
string
The user's ID on the external system managed by the SSO Identity Provider
Handle
string
The user's handle
First Name
string
The user's first name.
Last Name
string
The user's last name.
Division IDs
integer
A list of divisions to which the user will be assigned.
Target IDs
integer
A list of targets to assign to the user.
Name
string
The tag or attribute name
Value
string
The optional value
Send Invitation Email
boolean
Determines whether to send an invitation email to the user.
Invitation Message
string
An optional plain text message to include in the invitation email.
Notifications Default
string
Setting that controls when the users will start receiving email notifications.
Can Share Posts
boolean
Indicates if the user has the ability to share posts
Can Comment Posts
boolean
Indicates if the user has the ability to comment and like posts
Can Submit Posts
boolean
Indicates if the user has the ability to submit posts
Can Manage Organization
boolean
Indicates if the user has the ability to communicate with direct and indirect reports within the community

Returns

Update a post

Edits an existing post.

Required Parameters

ID
uuid
The post ID

Optional Parameters

Title
string
The title of the post
Description
string
The short description of the post
Tag Line
string
The tag line of the post
Content
string
The body of the post
Creator Comments
string
A message associated with the post
Perma Link
string
The external URL referenced by the post
Internal Discussions Enabled
boolean
Whether members are allowed to perform like action and add comments on posts internally

Returns

A post

Upload a document to a post

Uploads a document to a post via binary upload

Required Parameters

File Name
string
The document's preferred filename (with extension)
ID
uuid
The post ID
File
binary
File to upload
Content-Type such as image/jpg, image/pjpeg, image/png, image/x-png, image/gif
string
Content-Type of uploaded file

Returns

Information relevant to an attached document

Upload image

Uploads an image via binary upload

Required Parameters

File
binary
File to upload
Content-Type such as image/jpg, image/pjpeg, image/png, image/x-png, image/gif
string
Content-Type of uploaded file

Returns

Definitions

successResponse

A simple response indicating the action was carried out successfully

Code
string
A value of "success" indicates a successful operation

targetDefinitionsInfoResponse

A list of target definitions and associated targets for the community.

definitions
array of targetDefinitionInfoResponse
A list of target definitions and associated targets for the community.

targetDefinitionInfoResponse

Detailed information for a specific target definition and its associated targets

Allow Multiple Selections
boolean
Determines whether multiple targets can be selected
Get User Confirmation
boolean
Determines whether a user is asked to confirm/select their preference
ID
integer
The Id of the target definition
Name
string
The name of the target definition
Selection Required
boolean
Determines whether a selection in this definition is required
Target Selection Prompt
string
A customized label to prompt users to select their preference
childTargets
array of targetInfoResponse
Detailed information for a specific target definition and its associated targets

targetInfoResponse

Detailed information for a specific target.

Definition ID
integer
The ID of the target definition the target belongs to
Description
string
The targets descritption
ID
integer
The target ID
Is Subscribed
boolean
Whether the user is subscribed to a specific target
Name
string
The name of the target
Parent ID
integer
The ID of the targets parent, if it has one
childTargets
array of targetInfoResponse1
Detailed information for a specific target.

managePostTagsResponse

A list of post tags defined in the system

tags
array of managePostTagResponse
A list of post tags defined in the system

managePostTagResponse

Detailed information for a specific post tag

ID
integer
The tag ID
Is Available To Members
boolean
Determines if the tag is avilable to be used on member-facing post submission pages (if enabled)
Name
string
The tag name

manageUserTagsResponse

A list of user tags defined in the system

tags
array of manageUserTagResponse
A list of user tags defined in the system

manageUserTagResponse

Detailed information for a specific user tag

ID
integer
The tag ID
Name
string
The tag name
acceptedValues
array of string
Detailed information for a specific user tag
type
string
Detailed information for a specific user tag

categoriesResponse

Detailed information related to categories

Enable Category Subscription
boolean
Whether members are allowed to modify their category subscriptions
Landing Page Default Category
integer
The default content to show when loading news feed information
Require Subscription Selection
boolean
Whether members are required to select category subscriptions during onboarding
Subscription Prompt
string
The label to prompt members to select category subscriptions
categories
array of categoryResponse
Detailed information related to categories

categoryResponse

Description
string
The category description
Display Order
integer
The order in which to display the category
ID
integer
The category ID
Is Forced
boolean
Whether the authenticated user is force-subscribed to the given category
Is Hidden
boolean
Whether the category is hidden by an administrator
Is Pinned
boolean
Whether the category has been pinned by an administrator
Is Subscribed
boolean
Wther the authenticated user is subscribed to the given category
Is User Selectable
boolean
Whether users are allowed to select categories for submitted posts
Name
string
The category name
Parent Category ID
integer
The parent category ID
childCategories
array of categoryResponse1

postResponse

A post

postStatisticsResponse
postUserShareInfoResponse
userOverviewResponse
Summary information about a user
postAuthorRequestResponse
Actions
string
A JSON blob containing a list of action items for the post and URLs
Broadcasted
boolean
Whether the post has been broadcast to users for sharing
Classification
string
The type of post on the providers network.
Clean Perma Link
string
The permalink (excluding problematic spaces and newlines)
Click Points
integer
The number of points awarded when someone clicks on a shared link to the post
Content
string
The body of the post
Creator Comments
string
A message associated with the post
Current Time
date-time
The current time on the server.
Description
string
The short description of the post
End Date
date-time
The date the after which the post will no longer be available for viewing
Event End Date
date-time
The date the event ends (for event-type posts)
Event Start Date
date-time
The date the event begins (for event-type posts)
Is Commented By User
boolean
Whether the post has been commented on by the current user.
Is Discussion Viewed By User
boolean
Whether the posts discussion thread has been viewed by the current user
Is Liked By User
boolean
Whether the post has been internally liked by the current user.
Is Shared By User
boolean
Whether the post has been previously shared by the current user
Is Viewed By User
boolean
Whether the post has been viewed by the current user.
Language
string
The language of the post content
Location
string
Geographic location related to the post
Mentions
string
The mentions (users, hash tags, etc.) stored as a JSON blob.
Perma Link
string
The external URL referenced by the post
Pinned
boolean
Whether the post has been set for priority display in streams
Post ID
uuid
The post ID
Post Source ID
integer
The source ID
Properties
object
Miscellaneous properties of the post. Not available with all post types
Provider
string
The social provider from which the post originated (e.g., Facebook, Twitter).
Provider Post ID
string
The original ID of the post on the providers network
Provider Time Stamp
date-time
The date of the post from the providers perspective, i.e., when it was originally posted on the social provider
Publish Date
date-time
For user-submitted content, the date of post submission; for content imported from an external source, the publication date according to the source
Raw Content
string
The body of the post including all HTML (when both Content and RawContent are included)
Received Publish Points
boolean
Whether the user who submitted the post received points when the post was published
Sharable
boolean
Whether the platform and widgets will allow for the post to be shared
Share Images Only
boolean
Controls if posts shared to certain services are treated as image/photo only updates
Share Points
integer
The number of points awarded when a user shares the post
Share With Images
boolean
Controls if posts shared to short message services (like Twitter) have images shared
Short Suggested Share Text
string
The suggested share text for the post for short message providers
Start Date
date-time
The date after which the post is available for viewing
Suggested Share Text
string
The suggested share text for the post
Tag Line
string
The tag line of the post
Title
string
The title of the post
Url Slug
string
The SEO text to put in public links to the post
User Commentable
boolean
Indicates whether the current user is able to participate in dicussions on the post. If no current user, defaults to false.
User Editable
boolean
User Hidden
boolean
Whether the user has hidden the post from one or more streams
User Shareable
boolean
Indicates whether the current user is able to share the post. If no current user, defaults to true.
Visible
boolean
Whether the post is currently visible
approvalState
string
A post
candidateImages
array of postCandidateImageResponse
A post
categories
array of categoryOverviewResponse
A post
displayMode
string
A post
images
object
A post
links
array of postLinkRequestResponse
A post
media
array of postMediaRequestResponse
A post
postBylineType
string
A post
postSourceType
string
A post
postType
string
A post
shareCommentRules
array of postShareCommentRulesResponse
A post
shareDisclosures
array of postShareDisclosureResponse
A post
shortSuggestedShareTextList
array of string
A post
status
string
A post
suggestedShareTextList
array of string
A post
tags
array of postTagRequestResponse
A post
targets
array of targetOverviewResponse
A post

categoryOverviewResponse

Basic category information

ID
integer
The category ID
Name
string
The category name
Parent Category ID
integer
The parent category ID

targetOverviewResponse

A lightweight target response consisting of the targets name, ID, and the ID of the target definition it belongs to

Definition ID
integer
The ID of the target definition to which the target belongs
ID
integer
The targets ID
Name
string
The targets name

postShareCommentRulesResponse

Share Max Character Limit
integer
The maximum length of a users comment in a share on this provider.
provider
string

postShareDisclosureResponse

Provider Display Name
string
The providers display name
Share Disclosure Text
string
The disclosure text appended to each share
provider
string

postCandidateImageResponse

Height
integer
The images height
Mime Type
string
The images MIME type
Ssl Url
string
The images secure URL
Url
string
The images URL
Width
integer
The images width

postMediaRequestResponse

Description
string
The video format description
Duration
integer
The video duration in milliseconds
Has Video Url
boolean
Indicates that this media has a video URL that must be signed by using the "WatchVideo" include
Height
integer
The height of the media object in pixels
Html
string
HTML that can be used to render the media object
Mime Type
string
The MIME type of the media object
Name
string
The name of the media object
Origin
string
If available, specifies the original location of the media object
Provider
string
The social provider name
Role
string
The type of media (if determined)
Url
string
The URL to the media object
Width
integer
The width of the media object in pixels

postTagRequestResponse

Name
string
The tag name

postLinkRequestResponse

Caption
string
The short caption of the link (i.e., the text under the link)
Created Date
date-time
Description
string
The description of the link (i.e., the longer text under the caption)
Domain
string
The links domain
Expanded Url
string
The expanded URL (if it exists)
Favicon Url
string
The favicon URL of the link
Modified Date
date-time
Name
string
The name of the link assigned by the social provider
Title
string
The posts title
Url
string
The posts URL

postAuthorRequestResponse

Author
string
The stored text to display as the author.
Post Source Name
string
The name of the source of the post.
Post Source Site
string
The website in which the post originated
Profile Image Url
string
The authors profile picture on the social network
Profile Url
string
The authors profile URL on the social network
Provider User ID
string
The authors ID on the social network
Provider User Name
string
The authors name on the social network

postUserShareInfoResponse

Most Recent Share Date
date-time
Date of the users most recent share of this post
Points Earned
integer
The number of points earned by the user for sharing
Share Count
integer
The number of times the user shared

postStatisticsResponse

Click Count
integer
The count of clicks to the posts link from shares
Comment Count
integer
The count of internal comments on the post
Comment Like Count
integer
The sum of all likes across all internal comments on the post
Impression Count
integer
The potential views of a post by sharers friends and followers
Like Count
integer
The count of internal likes on the post
Reaction Count
integer
The count of reactions (likes, retweets, etc.) to shares
Share Count
integer
The count of shares initiated in the app that have been verified as successfully shared
Total In App Share Count
integer
Synonym for ShareCount
Tracking ID
string
Viewed Count
integer
The number of times the post has been visited by logged-in users

userOverviewResponse

Summary information about a user

Display Name
string
Display name of the user
Is Active
boolean
Whether the user is still an active member of the community
User ID
integer
ID of the user
profilePictureImages
object
Summary information about a user

uploadImageResponse

Image Identifier
string
The identifier to the uploaded image

userRequestResponse

userPrivilegesResponse
A users privileges
userPermissionsResponse
A managers permissions
userScheduleSettingsResponse
A users scheduled sharing preferences
postStatisticsResponse
userDefaultsRequestResponse
A collection of a users defaults
Api Info
string
API-specific property bag
Display Name
string
The users preferred display name
Email
string
The users email address
External Api User ID
string
The users ID on the external system managed by the caller of this API
First Name
string
The users first name
Full Name
string
The first and last name of the user
Handle
string
The users handle (the "user name")
Has Password
boolean
Whether the user has a password associated with the account.
ID
integer
The users internal ID
Is Account Verified
boolean
Indicates if the user has verified their email address
Is Sso
boolean
Whether the user is setup to authenticate using SSO
Last Activity Date
date-time
The last time the user interacted with the system.
Last Name
string
The users last name
Location
string
The users self-described location (may not be an actual geographic location)
Manager User ID
integer
The ID of the users manager (for organizational hierarchy features)
Must Change Password
boolean
Whether the user must change their password based on community settings
Point Balance
integer
The total points earned to date
Primary Language
string
The users primary interface language
Profile Completed
boolean
Whether the users profile was completed during onboarding
Redeemed Points
integer
The number of points redeemed over the users lifetime
Selected Time Zone
string
The users selected time zone represented as a tz database time zone name as set by IANA. Example: "America/Los_Angeles".
Time Zone
string
User time zone represented as a tz database time zone name as set by IANA. Example: "America/Los_Angeles".
Title
string
The users title
Unredeemed Points
integer
The points currently available for redemption
Welcome Banner Dismissed
boolean
Whether the user has dismissed the welcome banner
affiliations
array of userAffiliationResponse
badges
object
channels
array of userChannelResponse
displayNameFormat
string
divisions
array of divisionResponse
identifiers
array of whitelistIdentifiersResponse
languages
array of string
profilePictureImages
object
status
string
tags
object
targets
array of targetOverviewResponse

userDefaultsRequestResponse

A collection of a users defaults

Default Post Show Creator Info
boolean
The users default state when creating a post regarding showing creator name and photo
Default Post Show Internal Discussions
boolean
The users default post internal discussions state when creating a post
defaultPostApprovalState
string
A collection of a users defaults
defaultPostState
string
A collection of a users defaults

whitelistIdentifiersResponse

ID
integer
The whitelist definition ID
Value
string
The users response for the given whitelist definition

userPrivilegesResponse

A users privileges

Can Comment Posts
boolean
Indicates if the user has the ability to comment and like posts, based on their privileges and the community settings
Can Manage Community
boolean
Indicates if the user is a manager within community, based on their privileges and the community settings
Can Manage Organization
boolean
Indicates if the user has the ability to communicate with direct and indirect reports within the community, based on their privileges and the community settings
Can Set Post Shareable
boolean
Whether the user can set the Shareable status when submitting a post
Can Share Posts
boolean
Indicates if the user has the ability to share posts, based on their privileges and the community settings
Can Submit Posts
boolean
Indicates if the user has the ability to submit posts, based on their privileges and the community settings

userPermissionsResponse

A managers permissions

Community Settings
boolean
Allows the manager to view and edit community settings
Edit Broadcast
boolean
Allows the manager to create and edit broadcasts
Edit Post
boolean
Allows the manager to create and edit posts
Edit Survey
boolean
Allows the manager to create and edit surveys
List Broadcast
boolean
Allows the manager to view lists of broadcasts
List Post
boolean
Allows the manager to view lists of posts
List Survey
boolean
Allows the manager to view lists of surveys
View Broadcast
boolean
Allows the manager to view broadcasts
View Broadcast Stats
boolean
Allows the manager to view broadcast stats
View Post
boolean
Allows the manager to view posts
View Post Stats
boolean
Allows the manager to view post stats
View Survey
boolean
Allows the manager to view surveys

userScheduleSettingsResponse

A users scheduled sharing preferences

days
string
A users scheduled sharing preferences
times
array of string
A users scheduled sharing preferences

userChannelResponse

A user channel.

postStatisticsResponse
Auth Required
boolean
Whether the channels credentials need to be renewed
Display Name
string
The users display name on the social provider
Followers
integer
The number of followers the user has on the channel
Following
integer
The number of people the user is following on the channel
Friends
integer
The number of friends the user has on the channel
Name
string
The users name on the social provider
Point Balance
integer
The point balance of the user on the channel
Posts
integer
The number of posts the user has made on the channel.
Provider User ID
string
The providers user ID
Reach
integer
The users reach on the channel
Sharable
boolean
Whether the channel supports sharing
Sharing Default
boolean
Whether the channel is preselected for sharing
Source Display Name
string
The display name of the user channel when used as a content source
Url
string
The URL for the channel
User Channel ID
integer
The internal user channel ID
User ID
integer
The internal user ID
Views
integer
The number of views the user has on the channel
profilePictureImages
object
A user channel.
provider
string
A user channel.
status
string
A user channel.

divisionResponse

A division definition

Division ID
integer
The division ID
Name
string
The division name
Parent Division ID
integer
The ID of this divisions parent

userAffiliationResponse

A user affiliation

affiliationQuestionResponse
An affiliation question
affiliationAnswerResponse
An affiliation answer

affiliationAnswerResponse

An affiliation answer

Answer
string
The answer
Answer ID
integer
The answer ID
Decline To Answer
boolean
If set, this is the answer signifying that a user declined to answer the question.
Free Text
string
Text for questions with FreeText question type
Position
integer
The answers sorting position
Score
double
The score, if provided

affiliationQuestionResponse

An affiliation question

Description
string
The questions description
Is Publicly Visible
boolean
Name
string
The question
Question ID
integer
The question ID
Required
boolean
Whether the question has to be answered to register
Score Position
integer
The questions sorting position
questionType
string
An affiliation question

documentInfoResponse

Information relevant to an attached document

Extension
string
The documents file extension
File Name
string
The documents filename (with extension)
ID
uuid
The documents ID
Mime Type
string
The documents MIME type

divisionsResponse

The divisions defined in the system

Allow Multiple Divisions
boolean
Whether members are allowed to select multiple or only one division
Prompt
string
The label to prompt members to select a division
Require User Division Selection
boolean
Whether members must select their own division.
Show User Division Selection
boolean
Whether registered members can change their own division
Show User Division Selection During Onboarding
boolean
Whether new members should select their own division during registration
divisions
array of divisionResponse
The divisions defined in the system

categoryResponse1

Description
string
The category description
Display Order
integer
The order in which to display the category
ID
integer
The category ID
Is Forced
boolean
Whether the authenticated user is force-subscribed to the given category
Is Hidden
boolean
Whether the category is hidden by an administrator
Is Pinned
boolean
Whether the category has been pinned by an administrator
Is Subscribed
boolean
Wther the authenticated user is subscribed to the given category
Is User Selectable
boolean
Whether users are allowed to select categories for submitted posts
Name
string
The category name
Parent Category ID
integer
The parent category ID

targetInfoResponse1

Detailed information for a specific target.

Definition ID
integer
The ID of the target definition the target belongs to
Description
string
The targets descritption
ID
integer
The target ID
Is Subscribed
boolean
Whether the user is subscribed to a specific target
Name
string
The name of the target
Parent ID
integer
The ID of the targets parent, if it has one
childTargets
array of targetInfoResponse2
Detailed information for a specific target.

targetInfoResponse2

Detailed information for a specific target.

Definition ID
integer
The ID of the target definition the target belongs to
Description
string
The targets descritption
ID
integer
The target ID
Is Subscribed
boolean
Whether the user is subscribed to a specific target
Name
string
The name of the target
Parent ID
integer
The ID of the targets parent, if it has one
childTargets
array of targetInfoResponse3
Detailed information for a specific target.

targetInfoResponse3

Detailed information for a specific target.

Definition ID
integer
The ID of the target definition the target belongs to
Description
string
The targets descritption
ID
integer
The target ID
Is Subscribed
boolean
Whether the user is subscribed to a specific target
Name
string
The name of the target
Parent ID
integer
The ID of the targets parent, if it has one