Skip to content

docs: add requirement for user-installed apps in Jira integration #1242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 12, 2025
Merged

docs: add requirement for user-installed apps in Jira integration #1242

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
564e556
docs: add requirement for user-installed apps in Jira integration
codegen-sh[bot] Sep 12, 2025
9bfd2e4
Update instructions for Jira integration setup
kopekC Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions docs/integrations/jira.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,20 @@ Integrate Codegen with your Jira workspace to allow agents to interact with issu

Follow these steps to successfully connect Codegen to your Jira workspace:

### 1. Create a Dedicated Jira User for Codegen
### 1. Enable User-Installed Apps in Jira
- In your Jira workspace, ensure that **user-installed apps** are enabled.
- Make sure the setting to allow user-installed apps is enabled. This is required for the Codegen integration to work properly.

<Note>
If you don't have admin access to enable user-installed apps, contact your Jira administrator to enable this setting before proceeding.
</Note>

### 2. Create a Dedicated Jira User for Codegen
- In your Jira workspace, create a new user account specifically for Codegen.
- **Email:** Use an address with `codegen` in it, like `yourname+codegen@company_domain.com` or `codegen@company_domain.com`.
- **Name:** Set the user's name to **Codegen**. This makes it easy to identify actions performed by Codegen in Jira.

### 2. Authorize Codegen with the New Jira User
### 3. Authorize Codegen with the New Jira User
- Log in to Jira as the new Codegen user.
- Go to [Codegen's Jira Integration page](https://codegen.com/integrations/jira).
- Click **Connect Jira Workspace** and complete the OAuth flow **using the Codegen Jira user** you just created.
Expand All @@ -32,11 +40,11 @@ Follow these steps to successfully connect Codegen to your Jira workspace:
Make sure you are logged in as the Codegen Jira user when authorizing access. This is to ensure Codegen acts on behalf of the new user and not your personal account.
</Warning>

### 3. Switch Back to Your Own Jira Account
### 4. Switch Back to Your Own Jira Account
- After connecting, log out of the Codegen Jira user in Jira.
- Log back in with your personal Jira account.

### 4. Use Codegen in Your Workflow
### 5. Use Codegen in Your Workflow
- On any Jira ticket, `@mention` the Codegen user (e.g., `@Codegen`) to assign or notify Codegen about the issue.
- Codegen will interact with the ticket, update statuses, add comments, and link PRs as needed.

Expand Down