Configuring Acknowledge Support via Microsoft Teams

Add system environment variable IcoWebApi__IcoTeams__TeamsClientState (double underscore between the words) with a secret that will be used to establish subscriptions for Teams, and then restart both WebAPI and Alert REST Services.

Once Teams default configuration is set and working and you have IcoWebAPI Service setup to be publicly accessible and https secured, you can add the reply settings to enable acknowledge via Connected Field Services or Bridging.

To enable acknowledging Teams notifications from Connected Field Services or Bridging:

  1. Open Workbench and in Project Explorer, expand your project > Alarms and Notifications > Alert Notifications > MSTeams Configurations and double-click the desired configuration.

  2. In the Reply Settings section, select the Enable Subscriptions for Reply.

    New subscriptions for a user or a user group are only created when there is no existing subscription or when the existing subscription has expired.

  3. In the Acknowledge Keyword text box, enter the Teams message keyword that you want to use for acknowledgment. When you receive a Teams alert insant message (IM), use this keyword in Reply with quote to initiate the acknowledgment.

    The subscriptions that are created with a configured keyword use that keyword for the lifetime of the subscription. Once the subscription is established, any changes will only apply to future subscriptions.

  4. In Callback URL, specify a publicly accessible, https-secured webhook URL configured via WebAPI Service to which Teams should set up subscription and send subscription related webhook notifications. For example, xyz.com or https: //xyz.com:55 (https is added automatically if not provided).

    Any changes to this URL will only apply to future subscriptions. Existing subscriptions are not changed.
  5. In Subscription Validity, set the time period from 1 to a maximum of 72 hours (as restricted by Teams), for which the subscription is valid for a user or a user group, and then click Apply to save the configuration.

  6. To test the Teams IM Reply functionality, set up Bridging or Connected Field Services alarm configuration to send an alert using Teams. Once you receive an instant message from one these providers, use the Reply with quote option on the IM alert and use the acknowledge keyword set up in the configuration to acknowledge the alarm.