Extracting Employee Data with the BambooHR API - Practical Examples.

Apideck Documentation Page

Create a Jira Service Desk app & connect via Apideck

Sign up for Jira Service Desk

Go to the Atlassian website and Sign up - Try Atlassian Cloud | Atlassian to get a free account (no credit card required.)

Fill out the sign-up form with your details and click "Agree". You should receive a verification email.

Log in to Jira Service Desk

After you have signed up with Jira Service Desk, you can log in to Jira Service Desk to create an "Application".

You can do this by visiting the Atlassian Developer Center (https://developer.atlassian.com/) and clicking on "Log in" in the top right corner. Enter your login credentials and click on the "Continue" button.

Register a Jira Service Desk OAuth app

After you are logged in, go to the "Developer Console" page from the menu under your avatar in the right top part of the screen.

You can create a new OAuth app by clicking on the "Create" button within the "My Apps" section.

Select the "OAuth 2.0 integration" for creating a new application

This will take you to a form where you can enter the required information about your app:

  • App Name: Enter a meaningful name (for example, 'Apideck integration'), since when your users link their Jira Service Desk account, they will see the “App Name” is requesting to integrate.

Press "Create" to go ahead and create the app.

Configure your Jira Service Desk OAuth app

After creating your app, you'll need to configure it by setting up various settings and permissions.

This includes setting up OAuth 2.0 authentication, and configuring your app's terms & conditions, branding and icons.

Configure OAuth permissions

The next step is to configure the OAuth 2.0 permissions.

From the side menu, navigate to "Permissions".

Jira Service Desk API permissions

From the overview of Permissions, click on the "Add" button for Jira Service Desk API to configure the permissions.

For the Issue tracking, we recommend setting the following Jira Service Desk API permissions:

  • View Jira Service Desk issue data - read:jira-work Read Jira Service Desk project and issue data, search for issues, and objects associated with issues like attachments and worklogs.

  • Manage project settings - manage:jira-project Create and edit project settings and create new project-level objects (e.g. versions and components).

  • Manage Jira Service Desk global settings - manage:jira-configuration Take Jira Service Desk administration actions (e.g. create projects and custom fields, view workflows, manage issue link types).

  • View user profiles - read:jira-user View user information in Jira Service Desk that the user has access to, including usernames, email addresses, and avatars.

  • Create and manage issues - write:jira-work Create and edit issues in Jira Service Desk, post comments as the user, create worklogs, and delete issues.

  • Manage Jira Service Desk webhooks - manage:jira-webhook

    Register and manage Jira Service Desk webhooks.

  • Manage development - manage:jira-data-provider Manage development and release information for third parties in Jira Service Desk.

  • View Jira Service Desk request data - read:servicedesk-request Read Jira Service Desk request data and associated information.

  • Create and edit Jira Service Desk requests - write:servicedesk-request Create and edit Jira Service Desk requests, post comments, and manage request lifecycle.

  • Manage Jira Service Desk customers and organizations - manage:servicedesk-customer Manage customer accounts, organizations, and customer-related settings in Jira Service Desk.

  • Read Insight object schemas, objects, and object attributes - read:servicemanagement-insight-objects Access Insight data including object schemas, objects, and their attributes for service management.

Configure authorization

To manage the authorization, go to "Authorization" in the side menu.

Click on the "Add" button, to set the callback URI for the OAuth app.

Callback URL: The URL where the user will be redirected after granting your app access to their Jira Service Desk account. This should be https://unify.apideck.com/vault/callback.

Authentication details & app settings

To grab the authentication details, go to "Settings" in the side menu. After you have defined the authorisation, the Client ID & Secret will be automatically generated.

Click on the "Generate new secret" button to generate a new Client Secret.

💡 TIP: Copy the "Client Id" and the "Client secret". You will need them in the next step.

The app setting allows you to configure the name, avatar and description + the Authentication details.

Vault Connection Setup

Now that you have your Jira Service Desk App credentials, you can enable the integration to connect to your Jira Service Desk instance in a secure manner. Once this is done you can start testing it by using Jira Service Desk APIs and sandbox environment. You can also use Jira Service Desk sandbox environment to test your app's integration with Jira Service Desk without affecting real data.

Goto the Apideck > Configuration > Issue Tracking > Jira Service Desk

Enter the OAuth client ID & Secret from Jira Service Desk and review if the scopes granted in Jira Service Desk match with the scopes you are requesting in Apideck.

Press "Save settings" to save your credentials.

You can test the connection by clicking "Test Vault", which will check if the connection is working.

🚀Now you are ready and clients can authorize the connection to their Jira Service Desk account in a secure way.

Do your first Jira Service Desk API call via the Issue Tracking API

Connect your Jira Service Desk account through Vault with a test session.

To test the access token, make a call to the Jira Service Desk API endpoint using the Proxy API to get a list of incidents.

curl --location --request POST 'https://unify.apideck.com/proxy' \
--header 'x-apideck-consumer-id: test-consumer' \
--header 'x-apideck-app-id: {APIDECK_APP_ID}' \
--header 'x-apideck-service-id: jira-service-desk' \
--header 'x-apideck-downstream-url: https://api.atlassian.com/ex/jira/{cloud_id}/rest/servicedeskapi/request' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {APIDECK_API_KEY}' \

For more information, go to the Apideck Jira Service Desk connector documentation.