& MS Azure DevOps
This is a bi-directional integration between MS Azure DevOps and Kanbanize and it provides a basic linking of DevOps Work Items to Kanbanize Cards and vice-versa. There are several scenarios where this integration provides additional value:
Multiple Teams: when you have multiple teams working in Kanbanize and/or in DevOps and you need to bridge them. For example, Team A, Tram B, and Team C are working in Azure DevOps and Team K is working in Kanbanize and receives requests/tasks in the form of work items created in Azure DevOps.
As the rest of the teams are used with Azure DevOps they create work items for the Team K project in Azure DevOps and they also expect to receive comments and updates in Azure DevOps, while Team K uses the Kanban Method advantages and a complex workflow setup in Kanbanize.
Product Development / Project Management: Using related boards and implementing the Kanban Portfolio breakdown setup facilitate the Product and Project Managers in Kanbanize to monitor the overall work progress at different levels. Once the tasks are broken down for the teams to be executed, they are requested into their systems (Azure DevOps Projects) for execution.
Note: We do not support nor recommend scenarios where the team is expected to be able to work equally between the two systems. Like, half of the team is using only Azure DevOps and the other members are using only Kanbanize. As the systems compliment/enhance each other, there is no possibility for full replication, that's why only basic information is kept in sync to support the scenarios above.
- Bi-Directional linking of MS Azure DevOps work items and Kanbanize cards:
- Create Work Item / Kanbanize Card
- Update Work Item / Update Card Details
- Close Work Item / Move Card to Done
1. In Kanbanize, go to Administration -> Integrations -> MS Azure DevOps -> Configuration
Note: This might take a couple of seconds as the system is installing and preparing an integration module dedicated just for your account instance.
Hint: Through the integration setup, you might be required to make some modification to your Kanbanize Account and MS Azure DevOps Projects, so read this first to the end, so you know up-front what needs to be prepared and then start with the setup.
2. MS Azure DevOps Integration Login Credentials.
For security reasons you will be required to provide a set of login parameters:
I) Client ID & Client Secret:
These are OAuth Login parameters provided by MS Azure DevOps and to obtain them you need to register an MS Azure DevOps OAuth App with access to the projects you want to integrate. To Create such App and grand access follow these steps:
- Registration Link: https://app.vsaex.visualstudio.com/app/register
- For Homepage URL and Authorization callback URL add the following URL:
- Register your application and copy the App ID and App Secret that will be shown to you.
II) After applying the Client ID and Secret from Step I, you'll be redirected to MS Azure DevOps and asked to authenticate with a user, that will be used from Kanbanize to perform modifications in your MS Azure DevOps projects.
Note: For security and better traceability purposes, we propose to create and use a new/dedicated integration user. Once setup, enter its username and password.
3. MS Azure DevOps WebHook Registration
The integration provides a unique webhook URL for your account. Use this URL to register it to your Projects, you want to integrate. Copy the URL to use in the Webhook registration setup:
- Go to your MS Azure DevOps project page. Starting at the bottom left corner:
-> Project Settings -> Service Hooks -> Create New Subscription
- Select Web Hooks and click Next.
- From the Trigger Events options, select: Work Item Created
- Apply some filters if you need only specific work items to be linked.
- On the next step fill in the URL field with WebHook provided by Kanbanize.
Important: You need to register another Service hook subscription in MS DevOps for the other Trigger Event: Work Item Updated!
4. Optional WebHook Parameters
WebHook URL could look like this:
** if the card has been moved to another board the update/sync from MS Azure DevOps to Kanbanize will stop as the integration will not be able to locate the card.
5. Kanbanize Integration User
Select a user, which credentials will be used to make modifications on behalf of the MS Azure DevOps system. We advise to register a dedicated user, just for that purpose, as this is better for traceability and proper functioning of the integration.
Note: If you use your own user for example as the integration one, a modification made by you in Kanbanize will not be reflected in MS Azure DevOps as the system will treat this as an anti-loop mechanism and will prevent this changes from happening.
6. Select the Kanbanize Boards
From the Kanbanize side, you will be required to select a set of boards that would be mapped to your MS Azure DevOps Projects.
Note: If you don't see the boards you want to integrate, make sure the user is invited to those boards.
Important: The integration works 1:1 (Project Name : Kanbanize Board) for as many Projects and Boards as you've selected to integrate. In order to have this mapping, it is very important to have your Kanbanize Boards named exactly (Case Sensitive) as your MS Azure DevOps Projects.
7. MS Azure DevOps Integration Username
Type the exact username, already used in the authorization that is used to make modifications in MS Azure DevOps on behalf of Kanbanize changes. We advise registering a dedicated user, just for that purpose, as this is better for traceability and proper functioning of the integration.
This user name is used as an anti-loop mechanism to prevent duplicated changes.
8. MS Azure DevOps Organization
Type the exact Organization name (usually the name of the MS Azure DevOps account). For example you can locate the name, shown as the second part of your browser URL when accessing your MS Azure DevOps account.
Create / Update
Upon configuration as per the requirements above, when a work item is created, a new Kanbanize card will be created. Each work item update will be reflected on the cards as follows:
Work Item <-> Kanbanize card
Title <-> Title
Description <-> Description
Note: Ext. Link is the link to the MS Azure DevOps Work Item. Click on it to get access directly to the item and obtain detailed information directly from your MS Azure DevOps account.
Note: New Work Items/Kanbanize Cards are created in the backlog of the board. To get them created into another column/swimlane, just create a business rule for that particular board to move the card once it's been created or you could use the optional Webhook parameters.
Move / Change State
- From MS Azure DevOps to Kanbanize:
When an WorkItem state is changed in MS Azure DevOps, the integration system will try to move the corresponding Kanbanize Card in a column named exactly as the state you have in MS Azure DevOps.
- From Kanbanize to MS Azure DevOps:
When a Kanbanize Card is moved to a column the integration will try to update the "State" of the MS Azure DevOps matching exactly the name of the Column.
Note: Make sure when you design and configure your board, to keep one column (sub-column in the lowest level) named exactly as your States in MS Azure DevOps.