{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":21277,"path":"integrate-applications/integration-hub/jira-spoke-v3-0-2.md","title":"Jira Spoke","bundle":null,"doc_type":null,"release":"australia","body":"\n# Jira Spoke\n\nManage issues, users, stories, groups, projects, sprints, and webhooks, and look up audit logs in Jira. Retrieve Jira data to use in a flow. Use bi-directional webhooks and subscribe to Jira with a ServiceNow callback URL. Install Now Assist for Integration Hub and start using the available AI agents to perform tasks in your ServiceNow instance. Set up triggers for the required events to enable webhooks to connect with your ServiceNow instance.\n\n## Request apps on the Store\n\nVisit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the [ServiceNow Store version history release notes](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).\n\n## Integration Hub subscription\n\nThis spoke requires an Integration Hub subscription. For more information, see [Legal schedules - IntegrationHub overview](https://www.servicenow.com/content/dam/servicenow-assets/public/en-us/doc-type/legal/snc-addendum-integrationhub.pdf).\n\n## Spoke version\n\nJira spoke v6.1.3 is the latest version. For version history of the spoke, see [Jira spoke release notes](https://www.servicenow.com/docs/r/store-release-notes/store-integrationhub-rn-jira.html).\n\n## Spoke dependencies\n\nIf you’re having trouble installing the app, ensure that these dependent plugins are installed:\n\n- ServiceNow IntegrationHub Action Template - Data Stream \\(com.glide.hub.action\\_type.datastream\\)\n- Complex Object \\(com.glide.cobject\\)\n- ServiceNow IntegrationHub Action Step - Get Connection Info \\(com.glide.hub.action\\_step.get\\_connection\\_info\\)\n- ServiceNow IntegrationHub Runtime \\(com.glide.hub.integration.runtime\\)\n- ServiceNow IntegrationHub Action Step - REST \\(com.glide.hub.action\\_step.rest\\)\n- ServiceNow Flow Designer - Dynamic Inputs \\(com.glide.hub.dynamic\\_inputs\\)\n- Integrations - External Authentication Framework \\(com.glide.external.app\\)\n\n**Note:** Some of these plugins are licensable features and require an appropriate license if used outside the spoke implementation. For information on licenses, contact your account manager.\n\n## Supported versions\n\nThis spoke was built for API version v2, but may be compatible with later versions.\n\n**Note:**\n\n- If your Jira instance supports another API version, specify the API version in **API Version** in the respective connection record under the Attributes related list. By default, the **API Version** is `2`.\n- Jira Service Desk isn’t supported by the Jira spoke. ServiceNow offers [Jira Service Management Spoke](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/jira-serv-mngmt.md) to integrate with Jira Service Management that is the new version of Jira Service Desk.\n\n## Jira Webhooks module\n\nBi-directional webhooks can be set up to be notified about the required events. Routing policy defines conditions that must be met to notify the ServiceNow instance. These conditions are based on the events in Jira that you want to be notified about. When the conditions are met, the routing policy triggers the associated subflow, which in turn automates the Jira tasks.\n\nThe bi-directional webhooks require separate setup and can be used independently without using the spoke actions. By default, the Jira Webhooks application is available in the Jira and has the following modules:\n\n- Jira Webhook Registries\n- Jira WebHook Routing Policies\n\nUse the Jira Webhook Registries module to assign a token and provide the API path. You must generate a Callback URL here and provide the URL in Jira. A default routing policy is provided in the Jira WebHook Routing Policies module. The default routing policy supports these fields:\n\n\n
\n\nCategory\n\n\n\nField\n\n
\n\nIssue\n\n\n\n- Jira instance URL\n- Webhook Event\n- Issue Description\n- Created\n- Updated\n- Issue Resolution\n- Previous Issue Resolution\n- Issue Summary\n- Issue Type\n- Previous Issue Type\n- Issue Priority\n- Previous Issue Priority\n- Issue Status\n- Previous Issue Status\n- Issue Status Category\n- Previous Issue Status Category\n- Project\n\n
\n\nComment\n\n\n\n- Jira Instance URL\n- Webhook Event\n- Comment\n- Created\n- Updated\n- Issue Summary\n- Issue Type\n- Issue Priority\n- Issue Status\n- Issue Status Category\n- Project\n\n
\n\nWorklog\n\n\n\n- Jira Instance URL\n- Webhook Event\n- Worklog Time Spent\n- Created\n- Updated\n\n
\n\nAttachment\n\n\n\n- Jira Instance URL\n- Webhook Event\n- Created\n- Attachment File Name\n- Attachment Size\n- Attachment Mime Type\n\n
\n\nProject\n\n\n\n- Jira Instance URL\n- Webhook Event\n- Project\n\n
\n\nVersion\n\n\n\n- Jira Instance URL\n- Webhook Event\n- Version\n- Version Description\n- Merged To Version\n- Merged To Version Description\n\n
To use other conditions in the routing policy, create a routing policy in the Jira WebHook Routing Policies module and specify conditions as per your requirement. See [Set up a bi-directional webhook for the Jira spoke](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/setup-jira302-webhooks.md) for information regarding setting up and configuring the webhooks.\n\n**Tip:** To set up and use webhooks, you should configure webhook registries, decision tables, and create subflows. For a low-code alternative with less configurations, you can use [Spoke triggers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/jira-spoke-v3-0-2.md).\n\n## Spoke subflow\n\nThe Jira spoke provides a sample subflow to handle various Jira webhook events. The available sample subflow is Process Jira Webhooks. The Process Jira Webhooks subflow supports these fields:\n\n\n
\n\nCategory\n\n\n\nField\n\n
\n\nIssue\n\n\n\n- User\n- Issue\n- Attachments\n- Issue Change Log\n- Project\n\n
\n\nComment\n\n\n\n- Issue\n- Project\n- Comment\n\n
\n\nWorklog\n\n\n\nWorklog\n\n
\n\nAttachments\n\n\n\nAttachment\n\n
\n\nProject\n\n\n\nProject\n\n
\n\nVersion\n\n\n\nVersion\n\n
\n\nWebhook Event\n\n
\n\nTimestamp\n\n
\n\nPayload**Note:** This is the entire Jira payload.\n\n
To customize the default subflow, you must a create a copy of the sample subflow, parse the payload, and customize the subflow as per your requirement. Payload is one of the inputs to the subflow.\n\nWhile customizing subflows, you must ensure that the subflows are configured to avoid infinite loops.\n\n**Note:**\n\n- You must configure webhooks to use the spoke subflow. See [Set up a bi-directional webhook for the Jira spoke](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/setup-jira302-webhooks.md) for information regarding setting up and configuring the webhook.\n- The sample subflow runs as a user by default. The subflow can be configured to run as system.\n\n## Spoke triggers\n\nUse triggers in the Jira spoke to subscribe to the required events. The endpoint enables webhooks to connect with your ServiceNow instance. You can configure the flows to execute only when the specified trigger conditions are met. The supported events are:\n\n|Category|Trigger|Description|\n|--------|-------|-----------|\n|Board Management|Board Deleted|Trigger is initiated when a board is deleted.|\n|Board Updated|Trigger is initiated when a board is updated.|\n|Board Created|Trigger is initiated when a board is created.|\n|Comment Management|Comment Deleted|Trigger is initiated when a comment is deleted.|\n|Comment Updated|Trigger is initiated when a comment is updated.|\n|Comment Created|Trigger is initiated when a comment is created.|\n|Issue Managament|Issue Updated|Trigger is initiated when an issue is updated. The events like issue assigned, issue resolved, issue closed, issue reopened, issue moved, and other events that are related to updating an issue come under this webhook event.|\n|Issue Assigned|Trigger is initiated when an issue gets assigned.|\n|Issue Deleted|Trigger is initiated when a issue is deleted.|\n|Issue Created|Trigger is initiated when a issue is created.|\n|Sprint Management|Sprint Updated|Trigger is initiated when a sprint is updated.|\n|Sprint Deleted|Trigger is initiated when a sprint is deleted.|\n|Sprint Created|Trigger is initiated when a sprint is created.|\n|Sprint Closed|Trigger is initiated when a sprint is closed.|\n|Sprint Started|Trigger is initiated when a sprint is started.|\n\nFor information about setting up the triggers for the Jira spoke, see [Set up triggers for the Jira spoke](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/jira-ext-trigger.md). For more information about inbound integration, see [Conditional and event-driven inbound integration](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/conditional-and-event-driven-inbound-integration.md).\n\n## Spoke actions\n\nUse actions in the Jira spoke in Workflow Studio to automate Jira tasks when an event occurs in the ServiceNow AI Platform. Available actions include:\n\n**Note:**\n\n- Some of the spoke actions from this release onwards don't have the **Connection Alias** input.\n\n The existing flows in your instance that use actions of the previous versions, continue to work. However, those earlier actions are renamed by adding the `deprecated` suffix and you can't use them from this version onwards.\n\n- Error evaluation capabilities are provided in some of the spoke actions.\n\n\n
\n\nCategory\n\n\n\nAction\n\n\n\nDescription\n\n
\n\nAudit Management\n\n\n\nLook up Audit Logs Stream\n\n\n\nRetrieves login activity for the Jira user subscriptions.**Note:** This action is supported on Jira Server 9 and earlier versions, and Jira Cloud.\n\n
\n\nLook up Audit Logs Stream \\(Server 10+\\)\n\n\n\nRetrieves audit log records from the Jira instance within a specified date range.**Note:** This action is supported on Jira Server 10 and later versions.\n\n
\n\nGroup Management\n\n\n\nAdd User to Group\n\n\n\nAdds given user to a group in Jira.\n\n
\n\nCreate Group\n\n\n\nCreates a group in Jira.\n\n
\n\nLook up Groups Stream\n\n\n\nRetrieves all groups in the Jira account, including the default groups.**Note:** This action can be used with Jira Cloud subscription only.\n\n
\n\nLook up Users by Group Name Stream\n\n\n\nRetrieves details of all members in a Jira group.\n\n
\n\nRemove Group\n\n\n\nRemoves the given group from Jira.\n\n
\n\nRemove User from Group\n\n\n\nRemoves the given user from a group in Jira.\n\n
\n\nIssue Management\n\n\n\nAdd Comment\n\n\n\nAdds a comment to the specified issue in Jira.\n\n
\n\nAdd Watcher\n\n\n\nAdds the specified user as a watcher for the specified issue.\n\n
\n\nAssign Issue\n\n\n\nAssigns the issue in Jira to the user.\n\n
\n\nCopy Attachment\n\n\n\nCopies the required attachment associated with the ServiceNow record to the required issue in Jira.\n\n
\n\nCreate Issue\n\n\n\nCreates an issue in Jira. Depending on how your organization is using Jira, an issue could represent a software bug, a project task, a help desk ticket, or more. An issue in Jira represents a task in the ServiceNow AI Platform.\n\n
\n\nDelete Attachment\n\n\n\nDeletes the required attachment in Jira.\n\n
\n\nDelete Issue\n\n\n\nDeletes an issue in Jira.\n\n
\n\nDelete Watcher\n\n\n\nDeletes the user as a watcher for the specified issue.\n\n
\n\nDo Transition\n\n\n\nTransitions an issue in Jira from one state to another.\n\n
\n\nLook up Issue Type Statuses by Project\n\n\n\nRetrieves details of the statuses in a project.\n\n
\n\nLook up Issue\n\n\n\nRetrieves the details for an issue.\n\n
\n\nLook up Issue Priorities\n\n\n\nRetrieves the list of issue priorities and details for individual issue priorities.\n\n
\n\nLook up Issues Stream\n\n\n\nRetrieves a list of issues matching a JQL query string.\n\n
\n\nLook up Sprint Issues Stream\n\n\n\nRetrieves the details of all issues for the given sprint.\n\n
\n\nLook up Transitions\n\n\n\nRetrieves information about all Transitions for a given Issue ID.\n\n
\n\nLook up Watchers\n\n\n\nRetrieves the list of watchers for the specified issue.\n\n
\n\nUpdate Issue\n\n\n\nUpdates a set number of fields of an issue in Jira with values passed as input.\n\n
\n\nMetadata Retrieval\n\n\n\nGet Creatable Fields \\(Metadata\\)\n\n\n\nRetrieves the list of all fields in a required Jira project.\n\n
\n\nGet Editable Fields \\(Metadata\\)\n\n\n\nRetrieves the list of all editable fields in a required Jira issue.\n\n
\n\nGet Issue Types \\(Metadata\\)\n\n\n\nRetrieves the list of all issue types in a required Jira project.\n\n
\n\nProject Management\n\n\n\nCreate Project\n\n\n\nCreates a project in Jira.\n\n
\n\nLook up Project\n\n\n\nRetrieves details of the specified project by its ID or key.\n\n
\n\nLook up Projects\n\n\n\nRetrieves details of all projects.**Note:** This action only works for the Jira server.\n\n
\n\nLook up Projects Stream\n\n\n\nRetrieves details of all projects.**Note:** This action only works for the Jira Cloud.\n\n
\n\nLook up Users Assignable to Projects\n\n\n\nRetrieves a list of users that can be assigned to issues in one or more projects.\n\n
\n\nSprint Management\n\n\n\nCreate Sprint\n\n\n\nCreates a sprint in Jira.\n\n
\n\nDelete Sprint\n\n\n\nDeletes a sprint in Jira.\n\n
\n\nLook up Sprint\n\n\n\nRetrieves the details of the required sprint as a complex object.\n\n
\n\nLook up Sprints by Board\n\n\n\nRetrieves the details of all sprints in the required board.\n\n
\n\nUpdate Sprint\n\n\n\nUpdates the details of a sprint in Jira.\n\n
\n\nStory Management\n\n\n\nCreate Story\n\n\n\nCreates a story in the Jira Cloud instance. This is comparable to story in the ServiceNow Agile Development plugin.\n\n
\n\nLook up Stories Stream\n\n\n\nRetrieves details of all stories.\n\n
\n\nUpdate Story\n\n\n\nUpdates a set number of fields of a story in Jira Cloud with the provided input values.\n\n
\n\nUser Management\n\n\n\nCreate User\n\n\n\nCreates a user in Jira.\n\n
\n\nLook up Authenticated User\n\n\n\nRetrieves details of the authenticated user account.\n\n
\n\nLook up Group Memberships for User\n\n\n\nRetrieves details of all groups of a Jira user.\n\n
\n\nLook up Users Stream\n\n\n\nRetrieves details of all Jira user subscriptions.**Note:** This action can be used with a Jira Cloud subscription only.\n\n
\n\nLook up Users Stream by Name\n\n\n\nRetrieves a list of users that match the search string.**Note:** This action can be used with a Jira server subscription only.\n\n
\n\nRemove User\n\n\n\nRemoves a user from Jira.\n\n
\n\nReport Personal Data\n\n\n\nReports personal data for given accounts to the Jira app.\n\n
\n\nUtility Actions\n\n\n\nCopy Issue Attachment to Record\n\n\n\nCopies Attachment from Jira to any record in ServiceNow instance. When you use this action in a subflow, make sure that the Content URL data pill is specified in the Attachment URL field.\n\n
\n\nLook up Fields\n\n\n\nRetrieves the internal name and other details of the required field label in Jira.\n\n
\n\nLook up Issue from Comment\n\n\n\nRetrieves the details of the issue by parsing the payload for the specified comment. You can use this action in the Process Jira Webhook subflow for Jira on-prem server when only comment related information is specified without any details about the Jira issue. For example, when only comment information is specified, this action parses the payload and extracts the issue details.\n\n
\n\nLook up Latest Attachment on Issue\n\n\n\nRetrieves the latest attachment for the specified issue from Jira. You can use this action in a flow or subflow for validation. For example, a subflow adds an additional attachment only when the latest attachment of an issue in Jira isn’t as the same specified attachment.\n\n
\n\nLook up Latest Comment on Issue\n\n\n\nRetrieves the latest comment for the specified issue from Jira. You can use this action in a flow or subflow for validation. For example, a subflow adds an additional comment only when the latest comment of an issue in Jira isn’t as the same specified comment.\n\n
\n\nLook up Server\n\n\n\nRetrieves general information about the current Jira instance.\n\n
\n\nWebhook Management\n\n\n\nLook up Webhooks\n\n\n\nRetrieves details of all registered webhooks from the Jira instance.\n\n
\n\nSubscribe Webhook\n\n\n\nRegisters a webhook in the Jira instance.\n\n
\n\nUnsubscribe Webhook\n\n\n\nDeletes the registered webhook in Jira instance.\n\n
\n\nUpdate Webhook\n\n\n\nUpdates webhook with the given ID in Jira.**Note:** This action isn’t supported when OAuth 2.0 authentication is used.\n\n
## Available AI agents\n\nInstall Now Assist for Integration Hub and start using the available AI agents. For more information, see [ServiceNow Otto for Integration Hub](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/now-assist-spokes.md).\n\nThis spoke provides standalone AI agents that mimic human-like intelligence to perform tasks in your ServiceNow instance.\n\n- In the ServiceNow agentic system, you can create an agentic workflow that comprises of a set of large language model \\(LLM\\) instructions along with one or more standalone AI agents to execute an objective. See [Create an agentic workflow](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/configure-use-case-ai-agents.md) for information about adding AI agents to create agentic workflows as per your requirement and provide the required trigger.\n\n You can also search for other available AI agents and add them to your agentic workflow. See [Find AI agents](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/find-ai-agents.md) for more information.\n\n- You can create a clone of the required spoke AI agent and customize it as per your requirement. See [Duplicate an AI agent](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/clone-ai-agent.md) for more information about creating a clone.\n- See [AI Agent Studio \\(legacy\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/na-ai-agents.md) for information about AI agents.\n\nAvailable AI agents include:\n\n|AI agent|Description|\n|--------|-----------|\n|Jira story management AI agent|Retrieves information about stories in a stream, creates new stories, and updates existing stories.|\n|Jira utility management AI agent|Provides utility actions that can copy issue attachment to record, retrieve the latest attachment and comments on a Jira issue, and retrieve field details using labels. Ensures accurate data retrieval.|\n|Jira user management AI agent|Creates and removes the required user. Retrieves information about users, group memberships, and authenticated user accounts.|\n|Jira audit management AI agent|Manages audit logs and provides actionable insights by automating repetitive tasks.|\n|Jira sprint management AI agent|Deletes sprints, updates sprint details, and retrieves specific sprint information.|\n|Jira project management AI agent|Retrieves project details, creates new projects, retrieves project streams, and identifies users assignable to projects.|\n|Jira group management AI agent|Manages groups by performing actions such as, creating and deleting groups, adding and removing users, retrieving details about groups, retrieving data and updates, and retrieving group members.|\n|Jira issue management AI agent|Manages issues by performing actions such as, deleting issues, managing transitions, handling watchers, and working with attachments. Also, manages transitions, comments, attachments, and watchers.|\n\nThere might be AI agents installed on your instance that are not used in agentic workflows. To learn how to see all agents that are available to you, see [Find AI agents](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/intelligent-experiences/find-ai-agents.md).\n\n**Note:** Ensure that the user running an AI agent has the required roles and permissions to access data or perform operations on data in the table that is associated with the AI agent.\n\n## Jira account requirements\n\nThe Jira requires generating an API token for Jira using your Jira account.\n\n## Connection and credential alias requirements\n\nIntegration Hub uses aliases to manage connection and credential information. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection.\n\nThis spoke uses the Jira alias record. To use these actions, you must create a connection record and a credential record and associate them with the Jira alias record.\n\nThese actions use REST calls, which can run on an instance. Use the connection record associated with the Jira alias to configure the endpoint against which the actions run.\n\n"}}