How to use IBM® App Connect with Microsoft Viva Engage
Microsoft Viva Engage, previously known as Yammer, is a social networking and collaboration tool that aims to improve employee engagement across your company.
- App Connect Enterprise as a Service connector
Local
connector in containers (Continuous Delivery release) 12.0.7.0-r5 or
later-
Local connector in containers (Long Term Support Cycle-2 release)
Supported product and API versions
To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.
Connecting to Microsoft Viva Engage
Complete the connection fields that you see in the App Connect Designer page (previously the Catalog page) or flow editor. If necessary, work with your Microsoft Viva Engage administrator to obtain these values.
Microsoft Viva Engage connection fields:
| Authorization method | Connection field | Description | Applicability |
|---|---|---|---|
| BASIC OAUTH | Base URI | The URI for the Microsoft Viva Engage REST APIs. For example, https://www.yammer.com/api/. | App Connect in containers |
| Access token | The OAuth 2.0 access token for authentication Note: For more information about generating an
access token, see Oauth 2: Client and Service Side Flow in the Microsoft documentation.
|
||
| OAUTH 2.0 AUTH CODE |
Tip: Authorize connection to Microsoft
Viva Engage by signing in
to your account.
|
App Connect Enterprise as a Service |
To connect to a Microsoft Viva Engage endpoint from the App Connect Designer Applications and APIs page for the first time, expand Microsoft Viva Engage, then click Connect. For more information, see Managing accounts.
Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.
General considerations
Before you use App Connect Designer with Microsoft Viva Engage, take note of the following considerations:
- (General consideration) You can see lists of the trigger events and
actions that are available on the Applications and APIs page of the App Connect Designer.
For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
- (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.
Events and actions
Microsoft Viva Engage events
These events are for changes in this application that trigger a flow to start completing the actions in the flow.
| Object | Event | Description |
|---|---|---|
| Files | New file | Triggers when a new file is created in Microsoft Viva Engage |
| Groups | New or updated group | Triggers when a group is created or updated in Microsoft Viva Engage |
| Messages | New message | Triggers when a new message is created in Microsoft Viva Engage |
| Topics | New topic | Triggers when a new topic is created in Microsoft Viva Engage |
| Users | Deleted user | Triggers when a user is deleted from Microsoft Viva Engage |
| New user | Triggers when a new user is created in Microsoft Viva Engage |
Microsoft Viva Engage actions
Your flow completes these actions on this application.
| Object | Action | Description |
|---|---|---|
| Files | Delete file | Deletes a file that is completely uploaded in Microsoft Viva Engage |
| Groups | Retrieve groups | Retrieves group details in Microsoft Viva Engage |
| Messages | Create message | Create or post messages on Microsoft Viva Engage |
| Delete message | Deletes a specific message from Microsoft Viva Engage. This can be performed by the sender, a group admin, or a network admin. | |
| Retrieve message content | Retrieves a message with the specified topic name | |
| Retrieve messages | ||
| Retrieve messages about a topic | Retrieves messages that relate to the topic with the specified ID | |
| Networks | Retrieve networks | Retrieves details about the network the user is part of |
| Topics | Retrieve topics | Retrieves details about topics in Microsoft Viva Engage |
| User groups | Add user to group | Adds a user to a group in Microsoft Viva Engage. If the user is not in the network, this may trigger an invitation. |
| Retrieve users from group | Retrieves a paginated list of members from a specific group or community in Microsoft Viva Engage | |
| Users | Create user | Creates a new user in the Microsoft Viva Engage network. This is primarily for networks not using Native Mode; Native Mode networks should manage users via Azure Active Directory. |
| Delete user | Deletes a user permanently from the Microsoft Viva Engage network | |
| Invite user | Invites a user to join the Microsoft Viva Engage network | |
| Retrieve current user | Retrieves details for the logged-in user | |
| Retrieve users | Retrieves users from Microsoft Viva Engage |
Examples
Use templates to quickly create flows for Microsoft Viva Engage
Learn how to use App Connect templates to quickly create flows that complete actions on Microsoft Viva Engage. For example, go to the Discover page and search for Microsoft Viva Engage.