Connecting Azure DevOps to Stormboard

Setting up your bidirectional Azure DevOps integration with Stormboard

Do you have a question that isn't answered here? Check out the Stormboard For Azure DevOps FAQs.

Before starting the install make sure you have the following:

  • An active Stormboard Enterprise Account

  • A Stormboard Team Administrator who can do the setup in Stormboard

  • An Azure DevOps Admin with access to your ADO Service Account

  • A list of the Azure DevOps workspaces to be connected to Stormboard

Steps to Create a Personal Access Token

  1. Login to Azure DevOps as an administrator

  2. Click the user icon in the toolbar (1), then "Personal Access Tokens" (2)

    Stormboard dashboard help graphic
  3. On the Personal Access Token Page click "New Token"

  4. Create the Token

    1. Name the token "Stormboard"

    2. Set the expiration date to 1 year in the future (maximum available at the time of writing, if possible set it longer.)

      Note: If your Personal Access token is less time it will expire removing your connection with Azure DevOps until a new Personal Access Token is established. After 1 year this step will need to be required as well.

    3. Set Scopes to "Custom defined"
      - Only select Work Items - Read, Write & Manage

      Note: If you have required fields that involve selecting from a list of users (such as the "Assign To" field), you will need to set the Scopes to Full Access. 

      From the Azure DevOps Documentation: "Some of our public APIs are currently unassociated with a PAT scope, and can therefore only be used with “full-scoped” PATs." Click here to read more.

    4. Save the token.
      Note: You only get to see this once. Copy the token when it's provided to input in the Stormboard steps below.

      ADO setup graphic

Adding your Personal Token to Stormboard and creating your service hooks

  1. Login to Stormboard as a Team Administrator
    Note: If you are not sure who the Team Administrator is, please contact us for assistance.

    1. Click on your team under My Teams in the left panel.

    2. Under the Settings tab scroll down to Service Connections

      ADO settings graphic
    3. Click Connections

      ADO set up and connections graphic

      At the bottom select + New Connection choosing Azure DevOps from the dropdown. This will open the Configure Azure DevOps menu. 

Configure Azure DevOps in Stormboard

General

  1. Connection Name - Enter a Connection Name to find it in your Service Connections list

  2. Enabled - Turn your Service Connection on or off

  3. Default Connection - Choose if this is your Default Connection (if you have multiple services)

  4. User Authentication-

    1. Required OAuth Authentication will have every individual log-in with their credentials. Published information will be attributed to their accounts.

    2. Use Service Account Credentials will publish all information from the Service Account established.

  5. Organization - Enter your Azure DevOps Organization URL i.e. https://dev.azure.com/{organization}

    NoteOnly add the organization name not the entire URL. 

Service Account

  1. Username - Enter the username for your Azure DevOps service account

  2. Personal Access Token - Enter your Personal Access Token provided from the steps above

Service Hook

  1. Service Hook URL - Your Service Hook URL to be used for the below steps

  2. Connection Header - Your Connection Header to be used for the below steps

Steps to Create the Service Hooks (Webhooks)

There are three service hooks that need to be created to select multiple events. Create each individually.

  1. Still logged in as the Azure DevOps administrator navigate to the Project Overview screen

  2. Navigate to Project Settings on the bottom left

    Project settings graphic
  3. Select Service Hooks on the following screen

  4. Repeat the following steps for each of the following three events:
    Work Item Created, Work Item Deleted & Work Item Updated

  5. Click + to create a new Service Hook
    Note: If you have not yet created a Web Hook the option will read Create Service Hook

    Service hook graphic
    1. Scroll down and select Web Hooks

      Web hooks graphic
    2. Set the trigger remember you must do this for all three types individually

      Triggers graphic
      1. Select the event type

      2. Leave all filters blank

      3. To populate the Webhoook settings:

        1. Follow below instructions to create a Stormboard Connection retrieving the URL and HTTP Header from Stormboard

        2. Paste the values acquired from the Stormboard Connection

          Note: The Resource Version field MUST be manually set to [Latest]

        3. Leave all other fields blank or with default values

          Service hook settings graphic
 
Congratulations!

Your Azure DevOps integration should be ready. If you have any questions about any steps or are having issues testing your new integration contact us for troubleshooting assistance.