Configuring Webhook and Team ID

Edit online

This document explains how to configure Webhook and detailed steps to fetch Team ID which are needed when trying to connect Maximo IT with Microsoft Teams.

Obtaining value for Team ID

The Team ID is a mandatory field in the MSTEAMS tab of the ChatOps Configuration application. In order to obtain a value for this field, the following 3 key steps must be followed:
  1. Create a new Team in Microsoft Teams application.
    1. Log in to your Microsoft Teams account and click on the Teams tab in the left panel.
    2. From the New Items dropdown, click on New Team to create a new team.
    3. Give your new team a name in the Team name field and a description.
    4. Set Team as Public or Private and enter a name for your first Channel. Channels in this team will be used to view and update tickets in Maximo IT via Microsoft Teams application.
    5. Once done, click Create.
    6. New team is now created and saved in the Azure portal as well.
  2. Fetch Team ID from Azure Portal.
    1. Log in to the Microsoft Azure portal with your Microsoft account and go to Home page.
    2. On the Manage Microsoft Entra ID, click View.
    3. Go to Manage > Groups.
    4. Click on the Total Groups number.
    5. Find your Team name that you created in Microsoft Teams application in the previous step.
    6. Copy the Object ID for Teams. This is the unique Team ID for your Team.
  3. Enter value for Team ID in Maximo IT.
    1. Log in to Maximo IT and go to Integration > ChatOps Configuration.
    2. Open the MSTEAMS tab.
    3. Enter the Object ID copied in Step 2 (f) in the Team ID field.
    4. Save your changes.

Configuring Webhook in Microsoft Teams

To connect Maximo IT and Microsoft Teams, two Webhooks must be configured in Microsoft Teams application: Incoming webhook and Outgoing webhook. Use the steps below to configure each Webhook to enable the integration:

Configure an Incoming Webhook

  1. Go to the Microsoft Teams application and click on the Teams tab from the left pane.
  2. Find the Team you created and create a new channel in it where you will be posting messages to update tickets or view solutions.
  3. Click on the More options(three dots) next to the channel and click Manage Channel.
  4. Go to the Connectors section and click Edit.
  5. In the search box, enter 'Incoming webhook' and click on Configure for the search result. Also, select the Channel name that you will be using to execute commands from the Microsoft Teams application.
  6. To set up the webhook, enter a name for it. (For example, Maximoteams, teamsintegration, etc.)
    Note: Keep a note of this name as the webhook name set in this step will be used in the main command syntax when working on Microsoft Teams to update tickets in Maximo IT.
  7. Click Create.
  8. Microsoft Teams will generate a webhook URL. Copy and save it as this will be needed when configuring Maximo IT to enable the integration.

Configuring an outgoing Webhook

  1. Go to Microsoft Teams application and click on the Teams tab from the left pane.
  2. Navigate to the Team that you want to use to add an outgoing webhook and click on the More options icon next to it.
  3. Click Manage Team.
  4. Go to the Apps tab.
  5. Click on Upload an app button and click Create an outgoing webhook.
  6. Choose the team and click Set up.
  7. Give a name to your outgoing webhook in the Name field.
  8. In the Callback URL, enter the URL where the SlackProxy server is hosted.
  9. Click Create.
  10. The application will generate a Webhook secret or a Webhook Security Token. Copy it and store it safely as it will be used when configuring Maximo IT for the integration.

Test your webhook by entering a command using the following syntax

Test your webhook

When incoming and outgoing webhook is configured, you can test it by using the command. The command must follow the syntax below:

outgoing_webhook_name command [ticket number]

For example, if the name of your incoming webhook is 'maximoteams' and the command you set up is 'update [ticket number]', then the message that you enter in Microsoft Teams chat to update a particular ticket (eg. ticket number 1545) in Maximo IT will be as follows:

maximoteams update 1545

Similarly, you can enter a command to view a solution record in the Microsoft Teams application. For example, maximoteams solution 6658.