Delen via

Viva Engage

  • Reference

Viva Engage is a leading social network for businesses to get work done smarter and faster. Connect to Viva Engage to access conversations in your enterprise network.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Microsoft
URL Microsoft LogicApps Support
Microsoft Power Automate Support
Microsoft Power Apps Support
Connector Metadata
Publisher Microsoft
Website https://products.office.com/yammer/yammer-overview

Known issues and limitations

The following actions and triggers do not guarantee to return all messages, because of Viva Engage REST API limitations:

  • Get all messages
  • Get messages in a group
  • Get messages in a thread
  • Get the messages from my Following feed
  • When there is a new message in a group
  • When there is a new message in my followed feed

The following action returns maximum 100 groups, because of Viva Engage REST API limitation.

  • Get groups

For more information, please refer to Getting bulk content subsection of Yammer REST API Docs

Note

Viva Engage API restricts the number of messages only to 20. To workaround this limit, please refer to How to get all messages in a Yammer group using Microsoft Flow. For more details related to Viva Engage API limits, please visit the Yammer API rate limits.

Also, the following actions and triggers do not work with All company group, because of Viva Engage REST API limitations:

  • Get messages in a group
  • Get messages in a group (V2)
  • When there is a new message in a group

3rd Party Applications feature must be enabled in Yammer configuration. An action response such as "The response is not in a JSON format" typically means that feature is disabled.

The following actions allow you to create an "Announcement" post with a "Title" after setting the corresponding Advanced Parameters, however, this post will not be able to be edited in the Viva Engage UI. Viva Engage is aware of this issue and will address this issue in a future update.

  • PostMessage
  • PostMessageV2

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds
Frequency of trigger polls 1 15 seconds

Actions

Get all messages (V2) [DEPRECATED]

This action has been deprecated. Please use Get all messages (V3) instead.

This operation returns all public messages in the logged in user's Viva Engage network. Corresponds to "All" conversations in the Viva Engage web interface.
Get all messages (V3)

This operation returns all public messages in the logged in user's Viva Engage network. Corresponds to "All" conversations in the Viva Engage web interface.
Get all messages [DEPRECATED]

This action has been deprecated. Please use Get all messages (V3) instead.

This operation returns all public messages in the logged in user's Viva Engage network. Corresponds to "All" conversations in the Yammer web interface.
Get groups

Gets all groups. If mine = 1, get only groups to which the user belongs
Get messages in a group (V2) [DEPRECATED]

This action has been deprecated. Please use Get messages in a group (V3) instead.

This operation returns the messages posted in a group.
Get messages in a group (V3)

This operation returns the messages posted in a group.
Get messages in a group [DEPRECATED]

This action has been deprecated. Please use Get messages in a group (V3) instead.

This operation returns the messages posted in a group.
Get messages in a thread (V2) [DEPRECATED]

This action has been deprecated. Please use Get messages in a thread (V3) instead.

This operation returns the messages posted in a thread.
Get messages in a thread (V3)

This operation returns the messages posted in a thread.
Get messages in a thread [DEPRECATED]

This action has been deprecated. Please use Get messages in a thread (V3) instead.

This operation returns the messages posted in a thread.
Get my networks

Gets all the networks that the user belongs to.
Get the messages from my Following feed (V2) [DEPRECATED]

This action has been deprecated. Please use Get the messages from my Following feed (V3) instead.

This operation returns the messages from Following feed which is conversations involving people, groups and topics that the user is following.
Get the messages from my Following feed (V3)

This operation returns the messages from Following feed which is conversations involving people, groups and topics that the user is following.
Get the messages from my Following feed [DEPRECATED]

This action has been deprecated. Please use Get the messages from my Following feed (V3) instead.

This operation returns the messages from Following feed which is conversations involving people, groups and topics that the user is following.
Get user details

This operation returns user profile details.
Like message

This operation is used to like the specified message.
Post message (V2)

This operation is used to post a Message to a Group or All Company Feed. If group ID is provided, message will be posted to the specified group else it will be posted in All Company Feed.
Post message [DEPRECATED]

This operation is used to post a Message to a Group or All Company Feed. If group ID is provided, message will be posted to the specified group else it will be posted in All Company Feed.

Get all messages (V2) [DEPRECATED]

Operation ID:
GetAllMessagesV2

This action has been deprecated. Please use Get all messages (V3) instead.

This operation returns all public messages in the logged in user's Viva Engage network. Corresponds to "All" conversations in the Viva Engage web interface.

Parameters

Name Key Required Type Description
Unique identifier of the network
 network_id string

Network ID
Older than
 older_than integer

Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?older_than=2912″ to your request to get the 20 messages prior to those you’re seeing.
Newer than
 newer_than integer

Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page.
Thread type of messages
 threaded string

Threaded=true will only return the thread starter (first message) for each thread. This parameter is intended for apps which need to display message threads collapsed. threaded=extended will return the thread starter messages and the two most recent messages all ordered by activity, as they are viewed in the default view on the Viva Engage web interface.
Limit
 limit integer

Return only the specified number of messages.

Returns

List of one or multiple messages.

Message List
PageableMessageList

Get all messages (V3)

Operation ID:
GetAllMessagesV3

This operation returns all public messages in the logged in user's Viva Engage network. Corresponds to "All" conversations in the Viva Engage web interface.

Parameters

Name Key Required Type Description
Unique identifier of the network
 network_id string

Network ID
Older than
 older_than integer

Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?older_than=2912″ to your request to get the 20 messages prior to those you’re seeing.
Newer than
 newer_than integer

Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page.
Thread type of messages
 threaded string

Threaded=true will only return the thread starter (first message) for each thread. This parameter is intended for apps which need to display message threads collapsed. threaded=extended will return the thread starter messages and the two most recent messages all ordered by activity, as they are viewed in the default view on the Viva Engage web interface.
Limit
 limit integer

Return only the specified number of messages.

Returns

List of one or multiple messages.

Message List
PageableMessageListV2

Get all messages [DEPRECATED]

Operation ID:
GetAllMessages

This action has been deprecated. Please use Get all messages (V3) instead.

This operation returns all public messages in the logged in user's Viva Engage network. Corresponds to "All" conversations in the Yammer web interface.

Parameters

Name Key Required Type Description
Unique identifier of the network
 network_id string

Network ID
Older than
 older_than integer

Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?older_than=2912″ to your request to get the 20 messages prior to those you’re seeing.
Newer than
 newer_than integer

Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page.
Limit
 limit integer

Return only the specified number of messages.
Page
 page integer

Get the page specified. If returned data is greater than the limit, you can use this field to access subsequent pages

Returns

List of one or multiple messages.

Message List
MessageList

Get groups

Operation ID:
GetGroups

Gets all groups. If mine = 1, get only groups to which the user belongs

Parameters

Name Key Required Type Description
Network ID
 network_id string

Network ID
mine
 mine integer

Used for getting groups which user is part of
Show All Company Group
 showAllCompanyGroup integer

Used for showing All Company Group

Returns

response
array of YammmerEntity

Get messages in a group (V2) [DEPRECATED]

Operation ID:
GetMessagesInGroupV2

This action has been deprecated. Please use Get messages in a group (V3) instead.

This operation returns the messages posted in a group.

Parameters

Name Key Required Type Description
Network ID
 network_id string

Unique identifier of the network.
Group ID
 group_id True integer

Unique identifier of the group.
Older than
 older_than integer

Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?older_than=2912″ to your request to get the 20 messages prior to those you’re seeing.
Newer than
 newer_than integer

Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page.
Thread type of messages
 threaded string

Threaded=true will only return the thread starter (first message) for each thread. This parameter is intended for apps which need to display message threads collapsed. threaded=extended will return the thread starter messages and the two most recent messages all ordered by activity, as they are viewed in the default view on the Viva Engage web interface.
Limit
 limit integer

Return only the specified number of messages.

Returns

List of one or multiple messages.

Message List
PageableMessageList

Get messages in a group (V3)

Operation ID:
GetMessagesInGroupV3

This operation returns the messages posted in a group.

Parameters

Name Key Required Type Description
Network ID
 network_id string

Unique identifier of the network.
Group ID
 group_id True integer

Unique identifier of the group.
Older than
 older_than integer

Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?older_than=2912″ to your request to get the 20 messages prior to those you’re seeing.
Newer than
 newer_than integer

Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page.
Thread type of messages
 threaded string

Threaded=true will only return the thread starter (first message) for each thread. This parameter is intended for apps which need to display message threads collapsed. threaded=extended will return the thread starter messages and the two most recent messages all ordered by activity, as they are viewed in the default view on the Viva Engage web interface.
Limit
 limit integer

Return only the specified number of messages.

Returns

List of one or multiple messages.

Message List
PageableMessageListV2

Get messages in a group [DEPRECATED]

Operation ID:
GetMessagesInGroup

This action has been deprecated. Please use Get messages in a group (V3) instead.

This operation returns the messages posted in a group.

Parameters

Name Key Required Type Description
Network ID
 network_id string

Unique identifier of the network.
Group ID
 group_id True integer

Unique identifier of the group.
Older than
 older_than integer

Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?older_than=2912″ to your request to get the 20 messages prior to those you’re seeing.
Newer than
 newer_than integer

Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page.
Limit
 limit integer

Return only the specified number of messages.
Page
 page integer

Get the page specified. If returned data is greater than the limit, you can use this field to access subsequent pages

Returns

List of one or multiple messages.

Message List
MessageList

Get messages in a thread (V2) [DEPRECATED]

Operation ID:
GetMessagesInThreadV2

This action has been deprecated. Please use Get messages in a thread (V3) instead.

This operation returns the messages posted in a thread.

Parameters

Name Key Required Type Description
Thread ID
 thread_id True integer

Unique identifier of the thread.

Returns

List of one or multiple messages.

Message List
PageableMessageList

Get messages in a thread (V3)

Operation ID:
GetMessagesInThreadV3

This operation returns the messages posted in a thread.

Parameters

Name Key Required Type Description
Thread ID
 thread_id True integer

Unique identifier of the thread.

Returns

List of one or multiple messages.

Message List
PageableMessageListV2

Get messages in a thread [DEPRECATED]

Operation ID:
GetMessagesInThread

This action has been deprecated. Please use Get messages in a thread (V3) instead.

This operation returns the messages posted in a thread.

Parameters

Name Key Required Type Description
Thread ID
 thread_id True integer

Unique identifier of the thread.

Returns

List of one or multiple messages.

Message List
MessageList

Get my networks

Operation ID:
GetNetworks

Gets all the networks that the user belongs to.

Returns

response
array of Network

Get the messages from my Following feed (V2) [DEPRECATED]

Operation ID:
GetMessagesFollowingV2

This action has been deprecated. Please use Get the messages from my Following feed (V3) instead.

This operation returns the messages from Following feed which is conversations involving people, groups and topics that the user is following.

Parameters

Name Key Required Type Description
Network ID
 network_id string

Unique identifier of the network.
Older than
 older_than integer

Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?older_than=2912″ to your request to get the 20 messages prior to those you’re seeing.
Newer than
 newer_than integer

Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page.
Thread type of messages
 threaded string

Threaded=true will only return the thread starter (first message) for each thread. This parameter is intended for apps which need to display message threads collapsed. threaded=extended will return the thread starter messages and the two most recent messages all ordered by activity, as they are viewed in the default view on the Viva Engage web interface.
Limit
 limit integer

Return only the specified number of messages.

Returns

List of one or multiple messages.

Message List
PageableMessageList

Get the messages from my Following feed (V3)

Operation ID:
GetMessagesFollowingV3

This operation returns the messages from Following feed which is conversations involving people, groups and topics that the user is following.

Parameters

Name Key Required Type Description
Network ID
 network_id string

Unique identifier of the network.
Older than
 older_than integer

Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?older_than=2912″ to your request to get the 20 messages prior to those you’re seeing.
Newer than
 newer_than integer

Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page.
Thread type of messages
 threaded string

Threaded=true will only return the thread starter (first message) for each thread. This parameter is intended for apps which need to display message threads collapsed. threaded=extended will return the thread starter messages and the two most recent messages all ordered by activity, as they are viewed in the default view on the Viva Engage web interface.
Limit
 limit integer

Return only the specified number of messages.

Returns

List of one or multiple messages.

Message List
PageableMessageListV2

Get the messages from my Following feed [DEPRECATED]

Operation ID:
GetMessagesFollowing

This action has been deprecated. Please use Get the messages from my Following feed (V3) instead.

This operation returns the messages from Following feed which is conversations involving people, groups and topics that the user is following.

Parameters

Name Key Required Type Description
Network ID
 network_id string

Unique identifier of the network.
Older than
 older_than integer

Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?older_than=2912″ to your request to get the 20 messages prior to those you’re seeing.
Newer than
 newer_than integer

Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newer_than=3516″ to ensure that you do not get duplicate copies of messages already on your page.
Limit
 limit integer

Return only the specified number of messages.
Page
 page integer

Get the page specified. If returned data is greater than the limit, you can use this field to access subsequent pages

Returns

List of one or multiple messages.

Message List
MessageList

Get user details

Operation ID:
GetUserDetailsById

This operation returns user profile details.

Parameters

Name Key Required Type Description
User ID
 user_id True integer

Unique identifier of the user.

Returns

Properties of Viva Engage user.

User
User

Like message

Operation ID:
LikeMessage

This operation is used to like the specified message.

Parameters

Name Key Required Type Description
Message ID
 message_id True string

Unique id of the message.

Post message (V2)

Operation ID:
PostMessageV2

This operation is used to post a Message to a Group or All Company Feed. If group ID is provided, message will be posted to the specified group else it will be posted in All Company Feed.

Parameters

Name Key Required Type Description
Network ID
 network_id string

Unique id of the network.
Group ID
 group_id True integer

The group to post a message to (0 = All Company/Network).
Message Text
 body True string

Your message to be posted into your network.
Replied To Id
 replied_to_id integer

The message ID this message is in reply to.
Direct To Id
 direct_to_id integer

If set, a private message will be sent directly to the user with the indicated ID.
Broadcast
 broadcast boolean

Post message as an announcement to all users in a group.
Title
 title string

Title of the message to be posted.

Returns

List of one or multiple messages.

Message List
MessageListV2

Post message [DEPRECATED]

Operation ID:
PostMessage

This operation is used to post a Message to a Group or All Company Feed. If group ID is provided, message will be posted to the specified group else it will be posted in All Company Feed.

Parameters

Name Key Required Type Description
Network ID
 network_id string

Unique id of the network.
Group ID
 group_id True integer

The group to post a message to (0 = All Company/Network).
Message Text
 body True string

Your message to be posted into your network.
Replied To Id
 replied_to_id integer

The message ID this message is in reply to.
Direct To Id
 direct_to_id integer

If set, a private message will be sent directly to the user with the indicated ID.
Broadcast
 broadcast boolean

Post message as an announcement to all users in a group.
Title
 title string

Title of the message to be posted.
Topic 1
 topic1 string

Topic to apply to the message.
Topic 2
 topic2 string

Topic to apply to the message
Topic 3
 topic3 string

Topic to apply to the message.
Topic 4
 topic4 string

Topic to apply to the message
Topic 5
 topic5 string

Topic to apply to the message.
Topic 6
 topic6 string

Topic to apply to the message.
Topic 7
 topic7 string

Topic to apply to the message
Topic 8
 topic8 string

Topic to apply to the message.
Topic 9
 topic9 string

Topic to apply to the message.
Topic 10
 topic10 string

Topic to apply to the message.
Topic 11
 topic11 string

Topic to apply to the message.
Topic 12
 topic12 string

Topic to apply to the message.
Topic 13
 topic13 string

Topic to apply to the message.
Topic 14
 topic14 string

Topic to apply to the message.
Topic 15
 topic15 string

Topic to apply to the message.
Topic 16
 topic16 string

Topic to apply to the message.
Topic 17
 topic17 string

Topic to apply to the message.
Topic 18
 topic18 string

Topic to apply to the message.
Topic 19
 topic19 string

Topic to apply to the message.
Topic 20
 topic20 string

Topic to apply to the message.

Returns

List of one or multiple messages.

Message List
MessageList

Triggers

When there is a new message in a group (V2)

This operation triggers when a new message is posted in a group.
When there is a new message in a group [DEPRECATED]

This action has been deprecated. Please use When there is a new message in a group (V2) instead.

This operation triggers when a new message is posted in a group.
When there is a new message in my followed feed (V2)

This operation triggers when there is a new message in a network followed by you.
When there is a new message in my followed feed [DEPRECATED]

This action has been deprecated. Please use When there is a new message in my followed feed (V2) instead.

This operation triggers when there is a new message in a network followed by you.

When there is a new message in a group (V2)

Operation ID:
OnNewMessagesInGroupV2

This operation triggers when a new message is posted in a group.

Parameters

Name Key Required Type Description
Network Id
 network_id string

Unique identifer of the network.
Group Id
 group_id True integer

Unique identifier of the group.

Returns

List of one or multiple messages.

Message List
MessageListV2

When there is a new message in a group [DEPRECATED]

Operation ID:
OnNewMessagesInGroup

This action has been deprecated. Please use When there is a new message in a group (V2) instead.

This operation triggers when a new message is posted in a group.

Parameters

Name Key Required Type Description
Network Id
 network_id string

Unique identifer of the network.
Group Id
 group_id True integer

Unique identifier of the group.

Returns

List of one or multiple messages.

Message List
MessageList

When there is a new message in my followed feed (V2)

Operation ID:
OnNewMessagesFollowingV2

This operation triggers when there is a new message in a network followed by you.

Parameters

Name Key Required Type Description
Network ID
 network_id string

Pick a network.

Returns

List of one or multiple messages.

Message List
MessageListV2

When there is a new message in my followed feed [DEPRECATED]

Operation ID:
OnNewMessagesFollowing

This action has been deprecated. Please use When there is a new message in my followed feed (V2) instead.

This operation triggers when there is a new message in a network followed by you.

Parameters

Name Key Required Type Description
Network ID
 network_id string

Pick a network.

Returns

List of one or multiple messages.

Message List
MessageList

Definitions

User

Properties of Viva Engage user.

Name Path Type Description
Username
 name string

Username.
Job title
 job_title string

User job title.
Location
 location string

User location.
Full name
 full_name string

User full name.
First name
 first_name string

User first name.
Last name
 last_name string

User last name.
Profile url
 web_url string

User profile url.
Email
 email string

User email.
Birth date
 birth_date string

User birth date.
Photo url
 mugshot_url string

User photo url.

Message

Properties of a single Viva Engage message.

Name Path Type Description
ID
 id integer

ID associated with the post.
Text
 content_excerpt string

Text Content of the post.
Sender
 sender_id integer

Unique ID of user who posted the message.
Replied to
 replied_to_id integer

ID of the message to which this message is a reply.
Created At
 created_at string

Time at which the message was created.
Network
 network_id integer

Id of the network message is associated with.
Type
 message_type string

Descripton of the message type.
Sender Type
 sender_type string

Description of the type of sender.
Url
 url uri

API url of the post.
Web Url
 web_url uri

Web url of the post.
Group ID
 group_id integer

Unique ID of group who posted the message.
Message Body
 body MessageBody

Content associated with a single message.
Thread ID
 thread_id integer

Unique ID of thread.
Direct message
 direct_message boolean

Flag to specify if the post is a a direct message.
Client Id
 client_type string

Type of the client.
Client URL
 client_url uri

Web link of the client.
Language
 language string

Language used in the message.
Tagged User
 notified_user_ids array of integer

Details of users notified.
Privacy
 privacy string

Details of the privacy associated with the message.
liked_by
 liked_by LikedBy

Liked By
Is System Message
 system_message boolean

Flag to specify if the post is a system generated message or not.
Topics
 topics array of Topic

List of topics.

MessageV2

Properties of a single Viva Engage message.

Name Path Type Description
ID
 id integer

ID associated with the post.
Text
 content_excerpt string

Text Content of the post.
Sender
 sender_id integer

Unique ID of user who posted the message.
Replied to
 replied_to_id integer

ID of the message to which this message is a reply.
Created At
 created_at string

Time at which the message was created.
Network
 network_id integer

Id of the network message is associated with.
Type
 message_type string

Descripton of the message type.
Sender Type
 sender_type string

Description of the type of sender.
Url
 url uri

API url of the post.
Web Url
 web_url uri

Web url of the post.
Group ID
 group_id integer

Unique ID of group who posted the message.
Message Body
 body MessageBody

Content associated with a single message.
Thread ID
 thread_id integer

Unique ID of thread.
Direct message
 direct_message boolean

Flag to specify if the post is a a direct message.
Client Id
 client_type string

Type of the client.
Client URL
 client_url uri

Web link of the client.
Language
 language string

Language used in the message.
Tagged User
 notified_user_ids array of integer

Details of users notified.
Privacy
 privacy string

Details of the privacy associated with the message.
liked_by
 liked_by LikedBy

Liked By
Is System Message
 system_message boolean

Flag to specify if the post is a system generated message or not.

Topic

Properties of a single topic.

Name Path Type Description
ID
 id integer

Unique identifier of the topic.
Name
 name string

Name of the topic.

PageableMessageList

List of one or multiple messages.

Name Path Type Description
Messages
 value array of Message

PageableMessageListV2

List of one or multiple messages.

Name Path Type Description
Messages
 value array of MessageV2

MessageList

List of one or multiple messages.

Name Path Type Description
Messages
 messages array of Message

messages

MessageListV2

List of one or multiple messages.

Name Path Type Description
Messages
 messages array of MessageV2

messages

MessageBody

Content associated with a single message.

Name Path Type Description
Text
 parsed string

Parsed text format.
Plain
 plain string

Plain text format.
Rich
 rich string

Rich text format.

LikedBy

Liked By

Name Path Type Description
Count
 count integer

Number of distinct likes.
Names
 names array of object

List of people who liked the post.
Full Name
 names.full_name string

The full name of the person who liked the post.

Network

Properties of a single network.

Name Path Type Description
ID
 id string

Unique identifier of the network.
Name
 name string

Summary of the network.
Link
 permalink string

Web link to the network page.

YammmerEntity

Properties of a single Viva Engage entity.

Name Path Type Description
Description
 type string

Details of the Viva Engage entity.
Group ID
 id integer

Unique identifier of the group.
Full Name
 full_name string

Name of the Viva Engage entity.