Jira Spoke
-
- UpdatedAug 1, 2024
- 9 minutes to read
- Xanadu
- Now Platform Capabilities
Manage issues, users, stories, and groups in Jira. Retrieve Jira data to use in a flow. Use bi-directional webhooks and subscribe to Jira with a ServiceNow callback URL.
Request apps on the Store
Visit the ServiceNow Store website 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.
Integration Hub subscription
This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.
Spoke version
Jira spoke v5.1.0 is the latest version.
Spoke dependencies
If you’re having trouble installing the app, ensure that these dependent plugins are installed:
- ServiceNow IntegrationHub Action Template - Data Stream (com.glide.hub.action_type.datastream)
- Complex Object (com.glide.cobject)
- ServiceNow IntegrationHub Action Step - Get Connection Info (com.glide.hub.action_step.get_connection_info)
- ServiceNow IntegrationHub Runtime (com.glide.hub.integration.runtime)
- ServiceNow IntegrationHub Action Step - REST (com.glide.hub.action_step.rest)
- ServiceNow Flow Designer - Dynamic Inputs (com.glide.hub.dynamic_inputs)
- Integrations - External Authentication Framework (com.glide.external.app)
Supported versions
- If your Jira instance supports another API version, specify the API version in API Version under the Attributes related list. By default, the API Version is 2. See Configure a connection for Jira spoke for information about creating a Connection record.
- Jira Service Desk isn’t supported by the spoke.
Jira Webhooks module
Bi-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.
- Jira Webhook Registries
- Jira WebHook Routing Policies
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 for information regarding setting up and configuring the webhooks.
Spoke subflow
Category | Field |
---|---|
Issue |
|
Comment |
|
Worklog | Worklog |
Attachments | Attachment |
Project | Project |
Version | Version |
Webhook Event | |
Timestamp | |
Payload Note: This is the entire Jira payload. |
While customizing subflows, you must ensure that the subflows are configured to avoid infinite loops.
- You must configure webhooks to use the spoke subflow. See Set up a bi-directional webhook for the Jira spoke for information regarding setting up and configuring the webhook.
- The sample subflow runs as a user by default. The subflow can be configured to run as system.
Spoke triggers
Use 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:
Category | Trigger | Description |
---|---|---|
Board Management | Board Deleted | Trigger is initiated when a board is deleted. |
Board Updated | Trigger is initiated when a board is updated. | |
Board Created | Trigger is initiated when a board is created. | |
Comment Management | Comment Deleted | Trigger is initiated when a comment is deleted. |
Comment Updated | Trigger is initiated when a comment is updated. | |
Comment Created | Trigger is initiated when a comment is created. | |
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. |
Issue Assigned | Trigger is initiated when an issue gets assigned. | |
Issue Deleted | Trigger is initiated when a issue is deleted. | |
Issue Created | Trigger is initiated when a issue is created. | |
Sprint Management | Sprint Updated | Trigger is initiated when a sprint is updated. |
Sprint Deleted | Trigger is initiated when a sprint is deleted. | |
Sprint Created | Trigger is initiated when a sprint is created. | |
Sprint Closed | Trigger is initiated when a sprint is closed. | |
Sprint Started | Trigger is initiated when a sprint is started. |
For information about setting up the triggers for the Jira spoke, see Set up triggers for the Jira spoke. For more information about inbound integration, see Conditional and event-driven inbound integration.
Spoke actions
Use actions in the Jira spoke in Workflow Studio to automate Jira tasks when an event occurs in the Now Platform. Available actions include:
- Some of the spoke actions from this release onwards don't have the Connection Alias input.
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.
- Error evaluation capabilities are provided in some of the spoke actions.
Category | Action | Description |
---|---|---|
Audit Management | Look up Audit Logs Stream | Retrieves login activity for the AtlassianJira user subscriptions. |
Group Management | Add User to Group | Adds given user to a group in Jira. |
Create Group | Creates a group in Jira. | |
Look up Groups Stream | Retrieves all groups in the Atlassian account, including the default groups. Note: This action can be used with Jira Cloud subscription only. |
|
Look up Users by Group Name Stream | Retrieves details of all members in an Atlassian group. | |
Remove Group | Removes the given group from Jira. | |
Remove User from Group | Removes the given user from a group in Jira. | |
Issue Management | Add Comment | Adds a comment to the specified issue in Jira. |
Add Watcher | Adds the specified user as a watcher for the specified issue. | |
Assign Issue | Assigns the issue in Jira to the user. | |
Copy Attachment | Copies the required attachment associated with the ServiceNow record to the required issue in Jira. | |
Create Issue | Creates 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 Now Platform. | |
Create Issues | Creates up to 50 issues in bulk. The type of issue the action creates depends on the Jira setup. | |
Delete Attachment | Deletes the required attachment in Jira. | |
Delete Issue | Deletes an issue in Jira. | |
Delete Watcher | Deletes the user as a watcher for the specified issue. | |
Do Transition | Transitions an issue in Jira from one state to another. | |
Look up Issue Type Statuses by Project | Retrieves details of the statuses in a project. | |
Look up Issue | Retrieves the details for an issue. | |
Look up Issue Priorities | Retrieves the list of issue priorities and details for individual issue priorities. | |
Look up Issues Stream | Retrieves a list of issues matching a JQL query string. | |
Look up Sprint Issues Stream | Retrieves the details of all issues for the given sprint. | |
Look up Transitions | Retrieves information about all Transitions for a given Issue ID. | |
Look up Watchers | Retrieves the list of watchers for the specified issue. | |
Update Issue | Updates a set number of fields of an issue in Jira with values passed as input. | |
Metadata Retrieval | Get Boards (Metadata) | Retrieves the details of all boards in Jira. |
Get Creatable Fields (Metadata) | Retrieves the list of all fields in a required Jira project. | |
Get Editable Fields (Metadata) | Retrieves the list of all editable fields in a required Jira issue. | |
Get Issue Types (Metadata) | Retrieves the list of all issue types in a required Jira project. | |
Get Projects (Metadata) | Retrieves the list of all Jira projects. | |
Project Management | Create Project | Creates a project in Jira. |
Look up Project | Retrieves details of the specified project by its ID or key. | |
Look up Projects | Retrieves details of all projects. Note: This action only works for the Jira server. |
|
Look up Projects Stream | Retrieves details of all projects. Note: This action only works for the Jira Cloud. |
|
Look up Users Assignable to Projects | Retrieves a list of users that can be assigned to issues in one or more projects. | |
Sprint Management | Create Sprint | Creates a sprint in Jira. |
Delete Sprint | Deletes a sprint in Jira. | |
Look up Sprint | Retrieves the details of the required sprint as a complex object. | |
Look up Sprints by Board | Retrieves the details of all sprints in the required board. | |
Update Sprint | Updates the details of a sprint in Jira. | |
Story Management | Create Story | Creates a story in the Jira Cloud instance. This is comparable to story in the ServiceNow Agile Development plugin. |
Look up Stories Stream | Retrieves details of all stories. | |
Update Story | Updates a set number of fields of a story in Jira Cloud with the provided input values. | |
User Management | Create User | Creates a user in Jira. Note: This action isn’t supported when OAuth 2.0 authentication is used. |
Look up Authenticated User | Retrieves details of the authenticated user account. | |
Look up Group Memberships for User | Retrieves details of all groups of an Atlassian user. | |
Look up Users Stream | Retrieves details of all Atlassian Jira user subscriptions. Note: This action can be used with a Jira Cloud subscription only. |
|
Look up Users Stream by Name | Retrieves a list of users that match the search string. Note: This action can be used with a Jira server subscription only. |
|
Remove User | Removes a user from Jira. Note: This action isn’t supported when OAuth 2.0 authentication is used. |
|
Utility Actions | Copy Issue Attachment to Record | Copies 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. |
Look up Fields | Retrieves the internal name and other details of the required field label in Jira. | |
Look up Issue from Comment | Retrieves 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. | |
Look up Latest Attachment on Issue | Retrieves 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. | |
Look up Latest Comment on Issue | Retrieves 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. | |
Webhook Management | Look up Webhooks | Retrieves details of all registered webhooks from the Jira instance. |
Subscribe Webhook | Registers a webhook in the Jira instance. | |
Unsubscribe Webhook | Deletes the registered webhook in Jira instance. | |
Update Webhook | Updates webhook with the given ID in Jira. Note: This action isn’t supported when OAuth 2.0 authentication is used. |
Jira account requirements
The Jira requires generating an API token for Jira using your Atlassian account.
Connection and credential alias requirements
Integration Hub uses aliases to manage connection and credential information, and OAuth credentials. 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.
This 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.
These 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.