UI modifications support for Jira Service Management agent view now in Preview

You can now use UI modifications in the Jira Service Management (JSM) agent view. This is an extension of the existing jira:uiModifications module and covers the views your agents use inside a service project.

What's changing

UI modifications now support three specific agent views:

• Global issue create (GIC) - viewType: GICAgentView
• Issue view - viewType: IssueViewAgentView
• Issue transition - viewType: IssueTransitionAgentView

The agent view supports the same fields and methods as equivalent Jira views but is tailored for service projects.

Key differences include:

• Extension context: Exposes the requestTypeId of the work item.
• Supported fields: The set of supported fields differs from the JSM request create portal view.
• REST API: The UI modifications REST API (GET, POST, and PUT) now accepts these three agent view types. When configuring agent view contexts, portalId must not be set, and requestTypeId is optional (omitting it means the context is not scoped to a specific request type). One of projectId, issueTypeId, or viewType can act as a wildcard, with a maximum of one wildcard per context.

You can use view.getContext() to detect the current view type:

import { view } from '@forge/bridge';
import { uiModificationsApi } from '@forge/jira-bridge';

uiModificationsApi.onInit(async ({ api }) => {
  const context = await view.getContext();

  switch (context.extension.viewType) {
    case 'GICAgentView':
      // Runs when an agent creates a work item in a service project.
      break;
    case 'IssueViewAgentView':
      // Runs when an agent opens a work item in a service project.
      break;
    case 'IssueTransitionAgentView':
      // Runs when an agent transitions a work item in a service project.
      break;
    default:
      break;
  }
}, () => []);

What you need to do

No action is needed if you don't want to support the agent view. If you do want to add agent view support, simply define the context for the Agent View view types using the REST APIs – your Forge app will then be invoked automatically in the agent-specific views.

For more information, see:

• https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-service-management-ui-modifications/
• https://developer.atlassian.com/platform/forge/apis-reference/jira-api-bridge/uiModifications/