Jira Cloud Integration

Platform Configuration

Step 1: Create Service Account

  1. Navigate to User Management
  2. Create OpenHands Service Account
    • Click Service accounts
    • Click Create a service account
    • Name: OpenHands Agent
    • Click Next
    • Select User role for Jira app
    • Click Create

Step 2: Generate API Token

  1. Access Service Account Configuration
    • Locate the created service account from above step and click on it
    • Click Create API token
    • Set the expiry to 365 days (maximum allowed value)
    • Click Next
    • In Select token scopes screen, filter by following values
      • App: Jira
      • Scope type: Classic
      • Scope actions: Write, Read
    • Select read:jira-work and write:jira-work scopes
    • Click Next
    • Review and create API token
    • Important: Copy and securely store the token immediately

Step 3: Configure Webhook

  1. Navigate to Webhook Settings
    • Go to Jira Settings > System > WebHooks
    • Click Create a WebHook
  2. Configure Webhook
    • Name: OpenHands Cloud Integration
    • Status: Enabled
    • URL: https://app.all-hands.dev/integration/jira/events
    • Issue related events: Select the following:
      • Issue updated
      • Comment created
    • JQL Filter: Leave empty (or customize as needed)
    • Click Create
    • Important: Copy and store the webhook secret securely (you’ll need this for workspace integration)

Workspace Integration

Step 1: Log in to OpenHands Cloud

  1. Navigate and Authenticate
    • Go to OpenHands Cloud
    • Sign in with your Git provider (GitHub, GitLab, or BitBucket)
    • Important: Make sure you’re signing in with the same Git provider account that contains the repositories you want the OpenHands agent to work on.

Step 2: Configure Jira Integration

  1. Access Integration Settings
    • Navigate to Settings > Integrations
    • Locate Jira Cloud section
  2. Configure Workspace
    • Click Configure button
    • Enter your workspace name and click Connect
    • Important: Make sure you enter the full workspace name, eg: yourcompany.atlassian.net
      • If no integration exists, you’ll be prompted to enter additional credentials required for the workspace integration:
        • Webhook Secret: The webhook secret from Step 3 above
        • Service Account Email: The service account email from Step 1 above
        • Service Account API Key: The API token from Step 2 above
        • Ensure Active toggle is enabled
Workspace name is the host name when accessing a resource in Jira Cloud.Eg: https://all-hands.atlassian.net/browse/OH-55Here the workspace name is all-hands.
  1. Complete OAuth Flow
    • You’ll be redirected to Jira Cloud to complete OAuth verification
    • Grant the necessary permissions to verify your workspace access.
    • If successful, you will be redirected back to the Integrations settings in the OpenHands Cloud UI

Managing Your Integration

Edit Configuration:
  • Click the Edit button next to your configured platform
  • Update any necessary credentials or settings
  • Click Update to apply changes
  • You will need to repeat the OAuth flow as before
  • Important: Only the original user who created the integration can see the edit view
Unlink Workspace:
  • In the edit view, click Unlink next to the workspace name
  • This will deactivate your workspace link
  • Important: If the original user who configured the integration chooses to unlink their integration, any users currently linked to that workspace integration will also be unlinked, and the workspace integration will be deactivated. The integration can only be reactivated by the original user.

Screenshots