Jira Connector

Overview

The Firstbase Workflows node for Jira lets you create, update, and manage Jira issues, comments, attachments, and users directly from your Firstbase Workflows, and lets a change in Jira kick off a Firstbase workflow in return.

Common Use Cases Include:

• Creating a Jira issue when a new hire's IT provisioning task is created during Firstbase onboarding
• Adding a comment to an existing Jira issue when an offboarding task's status changes in Firstbase
• Creating a Jira issue when a device return or replacement request needs IT follow-up
• Updating a Jira issue's status when the corresponding Firstbase order or task is marked complete

Connection Overview

Firstbase Workflows supports two ways to connect to a Jira Software Cloud instance: an API token (email + token) or OAuth2 (Atlassian's "3LO" authorization code flow). API token setup is manual (generate and paste a token, rotate it yourself), while OAuth2 goes through an Atlassian consent screen and refreshes automatically. Either way, we recommend building the connection off a dedicated Jira service account rather than any one employee's personal Atlassian accounts. Once saved, either credential can be attached to any workflow step that reads from or writes to Jira.

Recommend Prep: Set up a dedicated Jira service account

If your organization doesn't already have one, create a dedicated Atlassian account for this integration rather than reusing a personal employee account, and give it whatever Jira project permissions the workflows you're building will need to touch.

Jira API Setup

To connect using an API token, you will need:

• A Jira account email (service account recommended — see above)
• A Jira API Token
• Your Jira domain (e.g. https://yourcompany.atlassian.net)

Step 1 - Generate an API Token

Log in to the service account's Atlassian profile and go to Security > API tokens (or use this direct link: <https://id.atlassian.com/manage-profile/security/api-tokens>). 

Select Create API Token, give it a name (e.g. "Firstbase Workflows"), set an expiration date, and select Create. Copy the token as you won't be able to view it again once you leave the page.
 

Important: A newly created token can take up to a minute to become active. If the credential fails verification on the first attempt in Firstbase Workflows, wait a minute and try again before assuming something's misconfigured.

Step 2 - Note your Jira domain

This is the URL your organization uses to access Jira, for example https://yourcompany.atlassian.net.

Cloud OAuth2 (3LO)

To connect using OAuth2, you will need:

• Access to the Atlassian Developer Console (https://developer.atlassian.com/console/myapps/)
• Client ID
• Client Secret
• Your Jira Domain
• Callback URL from the credential setup in Firstbase Workflows

Step 1 - Create the OAuth 2.0 app

In the Atlassian Developer Console, select Create -> OAuth 2.0 integration. Enter a name for the app, agree to the terms, and select Create.

Step 2 - Enable the 3LO authorization

In the left sidebar, next to OAuth 2.0 (3LO), select Add.

Step 3 - Generate Callback URL in Firstbase Workflows

In the Firstbase platform, navigate to the credential tab in Workflows. Click Credentials -> Create Credential (top right) -> Type "Jira" -> select “Jira SW Cloud OAuth2 API”. At the top you will find the OAuth Redirect URL. 

Step 4 - Paste Callback URL in Atlassian

Go back to Jira, Paste that URL into the Callback URL field in the Atlassian Developer Console, then select Save changes.

Step 5 - Grant API permissions and scopes

Select Permissions in the left sidebar, then select Add next to Jira API. Select Configure next to Jira API -> Edit Scopes, and enable at minimum these scopes, then save:

• read:jira-user
• read:jira-work
• write:jira-work
• manage:jira-webhook
• manage:jira-user
• offline_access

Step 6 - Copy your Client ID and Secret

Select Settings in the left sidebar. Copy the Client ID and Client Secret. Input them in the proper location in Firstbase Workflows.

Setup in Firstbase Workflows

These can be saved as a global credential, reusable across Workflows, or scoped to a single workflow. 

Step 1 - Navigate to Workflows

In the Firstbase platform, as an admin, click the Workflows tab.

Step 2 - Create the new credential

Create the new credential In Workflows, click Credentials -> Create Credential (top right) -> Type "Jira" -> select the credential option matching the method you set up above (Cloud (API token), Cloud (OAuth2), or Server). Enter the information you collected above into the corresponding fields. Once everything is entered (and, for OAuth2, once you've completed the consent flow), click Save. You now have a Jira connection ready for building workflows.

Step 3 - Using the credential in a workflow

Add the Jira node (or the Jira Trigger node, to start a workflow when something changes in Jira) to your workflow, and select the Jira credential you just created. Choose a Resource, then the Operation you need under that resource. 

Questions? Reach out to your Firstbase Solutions Engineer or Customer Success Manager