Skip to main content

Jira Software Destination

The Jira Software connector enables you to create issues, add comments, and manage project workflows in your Jira Software account. This connector supports creating and updating issues, adding comments, and managing project data through the Jira Software REST API.
jira_api.png

Jira Software

Configure Using a Template​

The following endpoint templates are available for configuring Jira Software destinations. These templates provide pre-configured settings for common API endpoints, making it easy to set up destinations without manual API configuration.

  • Select one of the following endpoint templates to configure your destination:

Add Comments to Issue​

Add Comments to Issue

This endpoint adds comments to existing issues in your Jira Software instance. Use this endpoint to add comments, status updates, or notes to specific issues. This endpoint is ideal for automated issue updates and team communication.

  • Ensure your data includes the Issue ID or Issue Key field that identifies the issue to which you want to add a comment.
  • Provide the comment text in your data. The comment text should be formatted according to Jira's text formatting requirements.
  • Optionally, configure comment visibility settings if your Jira instance supports restricted comments.

This endpoint requires a valid issue ID or issue key in your data. Ensure your dataset includes the issue ID or issue key field for successful comment creation. The issue ID should be the numeric ID of the issue, while the issue key is the alphanumeric identifier (e.g., PROJ-123). For detailed information about adding comments, refer to the Jira Software REST API comment documentation.

Create Issues​

Create Issues

This endpoint creates new issues in your Jira Software instance with bulk processing capabilities. Use this endpoint to create multiple issues in a single operation. This endpoint is ideal for automated issue creation and project management workflows.

  • Ensure your data includes the required fields for issue creation: Project Key, Issue Type, Summary, and optionally Description.
  • Provide additional issue fields as needed, such as assignee, priority, labels, or custom fields specific to your Jira instance.
  • The endpoint supports bulk creation, allowing you to create multiple issues efficiently in a single API call.

This endpoint supports bulk creation of issues. Ensure your data includes all required fields for successful issue creation, such as project key and issue type. The project key should match an existing project in your Jira instance, and the issue type should be valid for that project. For detailed information about creating issues, refer to the Jira Software REST API issue creation documentation.

Manual Configuration​

If the pre-configured templates don't meet your needs, you can manually configure custom Jira Software API endpoints.

API Method​

Select the HTTP method for your API request:

  • POST: For creating new resources (most common for Jira destinations)
  • PUT: For updating existing resources
  • PATCH: For partial updates to existing resources

Data Format​

Configure how your data will be formatted for Jira Software API consumption:

  • JSON: Most common format for Jira API (recommended)
  • Form Data: For specific Jira endpoints that require form encoding

JSON Configuration:

  • Content-Type: application/json
  • Data Structure: Ensure your data matches Jira's expected schema

API Endpoint URL​

Configure the complete Jira Software API endpoint URL:

  1. Base URL: Use your Jira Software instance URL from your credential (e.g., https://yourcompany.atlassian.net)
  2. API Path: Specify the Jira API resource you want to create or update (e.g., rest/api/2/issue, rest/api/2/issue/{issueId}/comment)
  3. Resource ID: For updates, include the specific resource ID in the URL path

Example URLs:

  • https://yourcompany.atlassian.net/rest/api/2/issue - Create new issues
  • https://yourcompany.atlassian.net/rest/api/2/issue/{issueId}/comment - Add comments to specific issue
  • https://yourcompany.atlassian.net/rest/api/2/issue/bulk - Bulk create issues

Request Headers​

Configure additional HTTP headers for API customization:

  • Authorization: Automatically handled by Nexla using your Jira Software credential
  • Content-Type: Usually application/json for Jira API
  • Accept: Specify response format (e.g., application/json)

Example headers:

Content-Type: application/json
Accept: application/json

Exclude Attributes​

Filter out unnecessary data fields before sending to Jira Software:

  • Field Names: Specify exact field names to exclude
  • Pattern Matching: Use wildcards for multiple fields (e.g., temp_*, debug_*)
  • Nested Fields: Use dot notation for nested field exclusion (e.g., metadata.debug)

Record Batching​

Configure how multiple records are grouped for efficient API calls:

  • Batch Size: Number of records per API call (Jira supports bulk operations)
  • Batch Method: How to handle multiple records (individual calls or bulk operations)
  • Error Handling: How to handle failures in batched operations

Bulk Operations:

  • Issue Creation: Use /rest/api/2/issue/bulk for efficient bulk issue creation
  • Comment Addition: Individual API calls for each comment
  • Issue Updates: Individual API calls for each issue update

Testing Your Configuration​

After configuring your Jira Software destination:

  1. Test Connection: Verify that Nexla can successfully connect to Jira Software
  2. Validate Data Format: Ensure your data matches Jira's expected schema
  3. Test Record Creation: Send a test record to verify the endpoint works
  4. Check Permissions: Ensure your credential has the necessary permissions for the operations

Jira Software has strict data validation requirements. Ensure your data matches the expected schema for the resource type you're creating or updating.

Important

Always test your Jira Software destination with appropriate permissions. Ensure your credential has access to create or update issues in the specific Jira projects you're targeting.