Integrating HCL DevOps Plan with Microsoft Teams using Webhooks

You can configure HCL DevOps Plan to automatically broadcast updates and lifecycle state modifications of your work items to collaboration platforms such as Microsoft Teams. You do this by creating notification webhooks that point to the target platform's incoming webhook URL.

Before you begin

Generate an Incoming Webhook URL in Microsoft Teams before you begin configuring HCL DevOps Plan.
Note: Microsoft retires legacy Office 365 Connectors. To avoid integration failures, use the Microsoft Workflows utility to establish all modern Teams incoming webhooks.
Generating a Microsoft Teams Incoming Webhook URL (Workflows App)
  1. Open Microsoft Teams and navigate to the Teams tab.
  2. Navigate to the target team and channel where you want to receive notifications. Select More options (...) menu for the channel, and then select Workflows.
  3. Search for Post to a channel when an incoming webhook request is received and select it.
  4. Verify your account connection if prompted, then choose the exact Team and Channel. Click Next.
  5. Once the workflow is created, copy the unique generated Webhook URL from the final screen.

Procedure

  1. Assign Webhook Administrative Permissions

    Only users who belong to the SCMIntegrationAdmins group can create and configure system-level webhooks.

    1. Log in to HCL DevOps Plan with administrator user credentials.
    2. From the main dashboard, select your Application/Tenant.
    3. Click the Navigation menu and select User Management.
    4. Navigate to the Groups tab and select SCMIntegrationAdmins.
    5. Click Add User, search for the target user profile, and click the add icon to move them into the group.
    6. Click Save.
  2. Configure the Target Webhook Master setup
    1. Log in with an account that has SCMIntegrationAdmins permissions.
    2. Open the New dropdown menu on the top-right toolbar and select WebhookMaster.
    3. Fill out the application form with the following criteria:
      Table 1. Application form
      Field Description / Value
      Callback URL Enter the primary application hostname or API endpoint pointing to your DevOps Plan deployment instance.
      Groups Allowed Search and add SCMIntegrationAdmins to grant maintenance and edit rights for this webhook setup.
    4. Click Save and Close.
  3. Create a Microsoft Teams Integration Rule
    1. Open the New dropdown menu on the top-right toolbar and select WebhookConfig.
    2. Under the Details section, fill in the configuration details exactly as specified below:
      Table 2. Configuration Mapping Table
      Field Name Microsoft Teams Setup Value
      Name TeamsConfig (or any descriptive name)
      URL Paste your generated Microsoft Teams Webhook URL. See Generating a Microsoft Teams Incoming Webhook URL.
      Secret Enter your authorization token/secret key if applicable
      Tracked Record Select WorkItem
      Webhook Type Select Notification
      Format Select Teams from the dropdown menu

      Setting up State & Action Triggers

      1. Click the Controls block/tab within the form layout.
      2. Under Actions, click the drop-down tool and map the work item transition events you want to track (example: choose Add all or specific events like Backlog, Close, Delete, Duplicate, Modify, PutBack, Resolve, Rework, Start).
      3. Under States, click the drop-down menu and select the corresponding record lifecycles to trace (example: Active, Backlog, Closed, Resolved, Submitted).
      4. Verify that the Active checkbox is checked.
      5. Click Save and Close.
  4. Validate the Integration flow
    To confirm that data broadcasts properly to Teams, perform an end-to-end event check:
    • Create any new item (Story, Task, Epic or Defect) and update it.
    • To verify the result: Open the configured Teams channel. The DevOps Plan bot posts an automated notification that displays real-time card details, including the item ID, ownership tags, urgency level, and state changes.