Transitioning your work to Craft.io means you can stay focused on what’s important to you as a product manager. To do so, it’s important to ensure your development tool is integrated correctly and that your development team’s workflow isn’t impacted as you transition to Craft.io. In this article, we’ll introduce the key building blocks to successfully set up an integration in Craft.io to your preferred development tool.
We integrate with the world’s most used development tools including Jira, Azure DevOps, Github, Gitlab, Pivotal Tracker and many more via our Zapier integration. At the end of this article, we’ve included links to detailed pages for each individual integration setups.
There are 4 key steps involved in configuring and managing a development tool integration.
Configure your integration settings so that we know how to map data between Craft.io and the development tool
Import your data to Craft.io to get started and fill Craft up with requirements
Establish a webhook on the development tool to ensure updates in that system are automatically sent back to Craft.io
And on a day to day basis, sync Craft.io with your development tool. You have the flexibility to decide to sync single items or in bulk, choosing from your entire Workspace, certain Releases or Sprints. Note that Craft.io will never delete items in your integration tool.
Let’s dive into each of the steps:
1. Configure the integration:
First, you need to establish an integration with your preferred development tool. Click on the Cogwheel icon on the bottom left of your screen to open the Integration settings page.
Each development integration allows you to define the following information:
Which Project or instances to connect with
So Craft.io knows which division of your tool to integrate with and has the authority to do so.
Administrator privileges to the specific project or instance.
Issue type mapping
To define what each Craft.io issue type maps to, e.g., Craft.io’s Features mapping to User Stories in Jira. This allows us to ensure data types are synced correctly.
Understanding of Craft.io’s data model and decisions on what data types are important to import from your development tool.
Field type mapping
To define a relationship between Craft.io field types and the available field types in your development tool. E.g., to define which field Craft.io’s Story points should be sent to within your Jira integration.
In certain instances, you may need to configure custom fields within your integration if there are important data in Craft.io you wish to pass down to your development tools.
Assignee and workflow synchronization
To define a relationship between Craft.io assignees and workflow statuses with the corresponding values in your development tool.
Decide which team members in your development tool should have an account on Craft.io.
If you decide to map workflows to your dev tool, you will need to ensure that the Craft.io team has the corresponding workflow. See more information on workflows here.
2. Import your existing data to Craft.io
Once the configuration is complete, you will have the choice to import your data directly to Craft.io. Here are some pointers:
Craft.io will import open issues only from your development tool. If you require a more detailed import, please contact our Customer Success team.
All data is imported into a new Product within your workspace. You can move these items in bulk using drag and drop within the Define > Spec Editor section of your Workspace.
You can decide to not import specific issue types to help keep your Workspace focused.
3. Establish a webhook
A webhook helps ensure that any recent changes in your development tool are automatically sent back up to Craft.io. Setting this up will help ensure that you are kept informed of recent changes automatically without needing to update the connection manually. Each development tool’s article provides in-depth steps to configure each integration’s webhook (see the links at the end of the article).
4. Sync your data
Once you’re ready to push new updates or brand new items to your development tool, you’ll have the following choices:
Option 1: Single item
Click on any item and select the relevant integration icon on the right-hand side properties. Click Sync item.
Options 2, 3 & 4: Entire Workspace, Specific Release(s) or Specific Sprint(s)
Go to Workspace Settings>Integrations and select the integration you wish to sync with (if the integration is already active - click on the 3 dots next to the integration name and select "Sync")
Select if you want to sync: Entire workspace, specific Releases or specific Sprints
Next up: Review the specific development tool article relevant to your organization.