Limitations
- Jira actions are designed for Jira Cloud and do not support Jira Server or Jira Data Center deployments.
- If administrators update the Jira actions pack configuration such as allowed tools or OAuth settings, existing connected accounts can be invalidated, and users might be asked to reauthenticate before the action works again.
Prerequisites
- An admin must complete Jira setup and enable the Jira actions pack so that Jira actions are available in Agent Builder.
- Each user is prompted to connect their Jira account in Glean before running agents that use Jira Edit issue.
- If your Jira organization uses centralized OAuth approval, a Jira administrator must authorize the Jira OAuth app for the site before users can run Jira actions.
Supported parameters
The underlying action defines the following parameters for Jira Edit issue.| Name | Type | Description |
|---|---|---|
| Issue ID or key | String | Identifier of the Jira issue to edit, such as an issue key like ENG-1234. |
| Assignee | String | New assignee for the issue. The exact format (for example, account ID vs. display name) is defined by the toolkit schema and Jira configuration. |
| Description | String | New description for the issue. For some projects, this may be a rich text field that expects structured content. |
| Due date | String | Optional due date for the issue, if your Jira project uses due dates. |
| Fields | String | Generic field map for advanced updates. Use this to set or update fields by their Jira field keys (including custom fields) when direct parameters are not enough. |
| Labels | Array | Labels to set on the issue. Behavior (replace vs. merge) depends on the toolkit’s mapping to Jira. |
| Notify users | Boolean | Flag that controls whether Jira notifies watchers and stakeholders about the edit. |
| Override editable flag | Boolean | Advanced flag that can bypass some “editable” constraints in Jira when allowed. Use only in trusted admin workflows. |
| Override screen security | Boolean | Advanced flag that can bypass some screen or field-visibility rules when permitted. Use with caution. |
| Priority ID or name | String | New priority for the issue, provided by either priority ID or human-readable name, depending on configuration. |
| Return issue | Boolean | Controls whether the updated issue payload is returned in the response. |
| Sprint ID or name | String | Sprint to associate the issue with, where applicable. |
| Summary | String | New summary for the issue. Many Jira projects require a non-empty summary. |
| Update | String | Low-level field operations object for advanced scenarios where you need fine-grained control beyond simple field replacement. |
Usage example
You want to update a feature request ticket with new information from customer feedback, including changing the priority and updating the description. Instruction to an agent: “Update Jira issue ENG-1234 with the following changes: change the summary to Improve batch API performance for large datasets, update the description to include the latest customer feedback about timeout issues with requests over 10,000 records, set the priority to High, and assign it to ABC from the API team.” Resulting behavior:- Identifies the Jira issue ENG-1234.
-
Calls the Edit issue action with:
-
Issue ID or keyset to ENG-1234. -
Summaryset to “Improve batch API performance for large datasets”. -
Descriptionupdated with the new customer feedback about timeout issues. -
Priority ID or nameset to High. -
Assigneeset to ABC’s account ID.
-
- Updates all specified fields in a single API call to Jira.
- Other fields like labels, sprint, and watchers remain unchanged.
Troubleshooting
Jira Edit issue times out or the agent reports a generic timeout
Jira Edit issue times out or the agent reports a generic timeout
- Possible cause: The underlying Jira API may be returning a 400 Bad request error, for example, due to empty required fields or invalid field structures, which can surface as timeouts or generic failures in some environments.
- Fix: Start with simple edits like summary and description only to confirm the action works. Then add additional fields gradually. Avoid sending empty strings for required fields like summary, and remove fields from the payload rather than sending empty values.
Invalid request payload. Refer to the REST API documentation and try again
Invalid request payload. Refer to the REST API documentation and try again
- Possible cause: Jira rejected the payload, often because one or more fields are not formatted the way that Jira expects especially complex custom fields or status-like fields sent via the generic fields map.
- Fix: Narrow the payload to a small set of simple fields like summary, description, priority and confirm they work. For custom fields, compare against how Jira stores that field, for example, export a sample issue via Jira’s UI or API) and align the structure of the fields payload accordingly.
Frequent reauthentication prompts for Jira Edit issue
Frequent reauthentication prompts for Jira Edit issue
- Possible cause: Updates to the Jira actions pack configuration such as changes to allowed tools or OAuth credentials invalidate existing connected accounts, which can require users to reauthenticate even if they did not change the Jira Edit issue step itself.
- Fix: Reauthenticate the Jira actions pack when prompted. If prompts continue to appear after every agent change, ask your Glean admin to confirm whether there are ongoing changes to the Jira actions configuration.
Your site admin must authorize this app for the site before the app can access your account
Your site admin must authorize this app for the site before the app can access your account
Tools backend returned 404 or 500 for this tool, or No connected account found
Tools backend returned 404 or 500 for this tool, or No connected account found
- Possible cause: The tools backend or Glean action runtime cannot reach the Jira action server, or there is no valid connected Jira account for the current user.
- Fix: Confirm that Jira actions are enabled and healthy in the Admin Console, that the appropriate Jira action pack is deployed, and that you have an active Jira OAuth connection. If errors persist, your admin may need to review backend logs for the Jira actions runtime.
FAQs
When should I use Jira Edit issue vs. Jira Assign issue vs. Jira Get issue?
When should I use Jira Edit issue vs. Jira Assign issue vs. Jira Get issue?
- Use Jira Get issue when you only need to retrieve an issue’s current state.
- Use Jira Assign issue when you only need to change who owns an issue.
- Use Jira Edit issue when you want to update several fields together in a single call (for example, summary, description, assignee, and priority).
Can Jira Edit issue update custom fields?
Can Jira Edit issue update custom fields?
Yes, as long as the payload matches the structure that Jira expects for that field.