Skip to main content

Jira Software Destination

Overview​

The Jira Software connector provides powerful data delivery capabilities for creating issues, adding comments, and managing project workflows. You can choose from pre-configured endpoint templates for common use cases or manually configure custom endpoints for specific data requirements.

Prerequisites​

Before creating a Jira Software destination, ensure you have:

  • A configured Jira Software credential (see Jira Software Authorization)
  • Understanding of Jira's data structure and API endpoints
  • Appropriate permissions for the Jira projects and issues you want to create or update

For complete information about Jira Software's API capabilities, see the official Jira Software API documentation.

Endpoint Templates​

The following pre-configured endpoint templates are available for common Jira Software data delivery scenarios:

  • Add Comments to Issue: Add comments to existing Jira issues
  • Create Issues: Create new Jira issues in bulk

Add Comments to Issue​

Add Comments to Issue

Add comments to existing issues in your Jira Software instance. This endpoint is ideal for automated issue updates and team communication.

  • Comment Data: Provide comment text, visibility settings, and metadata
  • Issue Association: Link comments to specific issue IDs
  • Team Communication: Enable automated status updates and notifications

This endpoint requires a valid issue ID in your data. Ensure your dataset includes the issue ID field for successful comment creation.

Create Issues​

Create Issues

Create new issues in your Jira Software instance with bulk processing capabilities. This endpoint is ideal for automated issue creation and project management workflows.

  • Issue Data: Provide issue details including summary, description, project, and issue type
  • Bulk Processing: Create multiple issues efficiently in a single operation
  • Project Integration: Assign issues to specific projects and components

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.

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.