Atlassian Integration

This guide walks you through the process of integrating Velocity with Atlassian to enhance incident investigation and resolution workflows.

You can use an API token to authenticate Velocity with your Atlassian products. You generate the token from your Atlassian account, then enter it into Velocity to complete the integration setup.

Create an API token

By default we set API tokens to expire in one year. When you create an API token, you can set the expiration date to be from 1 day up to one year.

Create an API token from your Atlassian account:

  1. Log in to https://id.atlassian.com/manage-profile/security/api-tokens.

  2. Select Create API token.

  3. Give your API token a name that describes what it does (e.g., "Velocity Integration").

  4. Select an expiration date for the API token.

  5. Token expiration is 1 to 365 days.

  6. Select Create.

  7. Select Copy to clipboard, then paste the token to your script, or save it somewhere safe.

You can't recover the API token after you're done with this step. We recommend you save your API token in a password manager.

You can specify what actions an API token has permission to perform - these are called scopes. The scope for an API token defines the levels of access to data in your Jira and Confluence apps. Scopes enhance security by allowing you to define specific permissions for API tokens.

Create a scoped API token from your Atlassian account:

  1. Select Create API token with scopes.

  2. Give your API token a name that describes what it does (e.g., "Velocity Integration - Jira Read Only").

  3. Select an expiration date for the API token.

  4. Token expiration is 1 to 365 days.

  5. Select Jira in the app selection screen.

  6. Select the following scopes for Velocity's read-only access:

    • read:jira-work - Browse projects and issues

    • read:jira-user - View user information and watchers

    • read:issue:jira - Browse issues and comments

  7. Select Create.

  8. Select Copy to clipboard, then paste the token to your script, or save it somewhere safe.

Note: If you also need Confluence access, you'll need to create a separate scoped token specifically for Confluence by repeating this process and selecting Confluence instead of Jira in step 6.

Submit your token to Velocity

  1. Log in to your Velocity account at https://app.velocity.tech

  2. Navigate to Application > Integrations.

  3. Select Jira from the available integrations.

  4. Enter your API token

  5. Click Create Integration to complete the integration setup.

Required permissions

Velocity requires the following read-only permissions to function properly:

For Scoped Tokens:

  • read:jira-work - Browse projects and issues

  • read:jira-user - View user information and watchers

  • read:issue:jira - Browse issues and comments

For Traditional Tokens:

  • Browse Projects

  • Browse Issues

  • View Development Tools

  • Browse Comments (if comment analysis is needed)

Important: When using scoped API tokens, you'll need to create separate tokens for Jira and Confluence if your integration accesses both products. Each scoped token is product-specific and uses different API endpoints.

Last updated