Integrations

Jira Integration Guide

Introduction

Sapling’s Jira integration allows tasks to be sent from Sapling to a specific Jira project, with the task status, description and title then kept in sync between the two systems. 

The task sent to Jira contains the following:

  • Name of the Task with the New Hire Name appended to the Task
  • Description of the Task 
  • Due Date of the Task.

 ​

​How to set-up the Jira integration

Step #1 - Create your Project in Jira

 ​​This can be named anything, however we typically suggest ‘Employee Transition Management’.

 

Step #2. Add your Jira Project to Sapling

In Sapling, navigate to Admin>Integrations.

Then add your Jira domain and Project key (your domain must include https://).

​ 

You'll then be able to Generate your Consumer Key, Consumer Name and Public Key

​ 

Step #3. Configure the integration in Jira

In Jira, navigate to Settings > Products > Applicant Links

 

 

We then create a new link and Configure the Applicant URL. The link should be: 

https://[yourcompanyname].saplingapp.io

For example: 

https://rocketship.saplingapp.io

 

 

You'll then be able to input the Consumer Name. Do not enter any other information at this step and simple press continue.

  

Once saved, then edit the new link and add the:

  • Consumer Key
  • Public Key

Then click Continue.

Step #4. Confirm and launch the integration in Sapling

In Sapling, we then click Launch Integration and provide Jira permission to send information into your account (to update the status of activities).

Finally, select the Jira state that matches Sapling's completed state (typically 'Done').

How to set-up tasks to be sent to Jira

Once you have the Jira integration enabled, Admin and Account Owners can confirm which Tasks should be sent to become Jira tickets.

This is done on the Admin>Workflows page in Sapling. When creating a new task (or modifying an existing task) - change the Assigned to Jira.

​​Note that if you'd like to manage due dates through sapling, then you must set due date screens on Jira from 'Issues/Field Configurations'. 

  

Once assigned to Jira, you will see the Jira icon as the task owner of the task. This means that when we assign the task, it will be sent to Jira.  Tasks can be assigned in the onboarding or offboarding flows, or the Tasks Page.

 

When Tasks are completed in Jira (as the specified status in Jira project), the Tasks in Sapling will automatically be updated.

Frequently Asked Questions

Will changes in tasks be sent to Jira?

  • Yes - any changes in tasks (title, description or due date) wil be sent to Jira.

How can I ensure the Jira integration is working?

Please review and confirm  the following:

  • Ensure that in the project's permission scheme, you have given the permission Schedule Issues.
  • Check what Field Configuration Scheme the project is using. Inspect the specific Field Configuration for the issue type in question. See if the field Due Date is currently in a hidden state. If so, click Show to unhide it.
  • Check which screens your project is using. Ensure that you've placed "Due Date" on the proper screens.

What action do I need to take if I am unable to launch the integration?

  • The issue maybe that  you'll need to configure the Application link in Jira first.

Can I set up the integration to speak to multiple Jira projects?

  • Sapling can only integrate with one Jira project at this time.

Once the integration is setup, who will the ticket be assigned too?

  • When a ticket comes in it will be unassigned.

Still no luck? We are here to help!

People Operations can be complex - contact our customer success team to get in touch with you.

Contact Us