How to setup Teams Notifications in HEDDA.IO?

Teams Events in HEDDA.IO enable you to send notifications to Microsoft Teams Channels or private messages, triggered by specific conditions within HEDDA.IO.

Creating a Teams Event Sink

To set up notifications, you need to create an Event Sink, which is the configuration used to connect HEDDA.IO to a service like Teams.

1. Navigate to the Events page. Note that the Events page is configured project-wide, meaning you must create or access an existing project before proceeding.
2. On the Events page, click Add Event Sink, which opens a configuration form in a side panel.
3. In the Select Sink Type dropdown, choose Teams. This will reveal a single required input field: the Incoming Webhook URL. Learn how to obtain an Incoming Webhook URL at the very bottom of this guide.
4. Paste the Webhook URL into the field and click Save.

Creating an Event Using the Event Sink

Once the Event Sink is set up, you can define events that trigger notifications:

1. In the Events page, select the Teams Event Sink you created.
2. Inside the Events canvas, click the Add Event button in the top-right corner. This opens an event configuration form.
3. Fill in the following fields:
   • Name: The name for the event.
   • Description: Details about the event.
   • Event Type: Select the trigger condition for the event from the dropdown.

HEDDA.IO currently supports six Event Types. Select the appropriate type, and additional fields will appear based on your selection.

Common Fields for All Event Types

At the bottom of the form, you will find fields for Title/Subject and Template. These define the message sent to Teams. Each Event Type comes with preconfigured default values for these fields, but you can customise them by enabling the Template Override toggle. When enabled:

• The Title/Subject and Template fields become editable.
• A list of tokens is displayed, which you can use to dynamically populate the message content.

Posting a Simple Title and Message to a Teams Channel

To send a basic message with a title to a Teams Channel:

1. Use the 'Parse JSON' action after the 'When a Teams webhook request message is received' action in the Workflow.
2. In the 'Content' input, use the Body from the previous action (found under Dynamic content).
3. Add the following schema in the 'Schema' input field:

{  
    "type": "object",  
    "properties": {    
        "Title": {  
            "type": "string"    },    
        "Text": {      
            "type": "string"    }  
    } 
}

Here, Title represents the Title/Subject, and Text represents the Template. These can be used in Teams Workflow actions, such as 'Post message in a chat or channel'.

Posting a Card to a Teams Channel

When detailed information needs to be presented, use a Card format:

1. Design your Template in JSON, such as:

{  
    "ProjectId": "{{project.id}}",  
    "ProjectName": "{{project.name}}",  
    "ProjectDescription": "{{project.description}}",  
    "KnowledgeBaseId": "{{knowledgebase.id}}",  
    "KnowledgeBaseName": "{{knowledgebase.name}}",  
    "KnowledgeBaseDescription": "{{knowledgebase.description}}",  
    ... 
}

2. Modify the Template by removing any unnecessary properties and tokens for this Event, or include additional properties and tokens that are relevant to your needs.
3. Use the above Template in JSON in the 'Parse JSON' action to generate a schema from the sample.
4. In the final Workflow step, use the 'Post card in a chat or channel action', which requires an Adaptive Card in JSON format.

Adaptive Card Design

You can use the Microsoft Adaptive Cards Designer to create an adaptive card. Copy the generated JSON representation of the card and paste it into the Workflow.

Finally, replace or add the data from the parsed JSON to the Adaptive Card as dynamic content.

Creating an Incoming Webhook in Teams

As Microsoft 365 Connectors are deprecated, use Workflows to create incoming webhooks for Teams. Follow this guide to set up an incoming webhook using Workflows for Microsoft Teams.

Events Log

You can easily monitor the status of triggered events in the Event Log, located next to the Events page.

The Event Log provides a detailed record of all activities initiated within the project's events.