New Version 1

Create a webhook to send data from Jira to an instance URL

Registering a [Dynamic Webhook](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/) requires supplying a [highly configurable payload called "Webhook Details"](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/#api-rest-api-3-webhook-post). It's important to configure this for all use cases as each Jira app is only permitted to create and manage one endpoint.

# Registering a Webhook Notes
Please note that whenever trying to register a webhook, the request payload's structure is different depending on the authentication method:
  - For Basic Auth, the payload should be structured as follows on this article: [Basic Auth Webhook Payload Structure](https://developer.atlassian.com/cloud/jira/platform/webhooks/#registering-a-webhook-using-the-jira-rest-api--other-integrations-)
```json
{
  "name": "my first webhook via rest",
  "description": "description of my first webhook",
  "events": [
    "jira:issue_created",
    "jira:issue_updated"
  ],
  "filters": {
    "issue-related-events-section": "Project = JRA AND resolution = Fixed"
  },
  "excludeBody" : false,
  "secret" : "G8j4166a5OkXRD4WbqV3"
}
  ```
  - For OAuth, the payload should be structured as follows: [OAuth Webhook Payload Structure](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/#api-rest-api-3-webhook-post)
```json
[
  {
    "events": ["jira:issue_created", "jira:issue_updated"],
    "fieldIdsFilter": ["summary", "customfield_10029"],
    "jqlFilter": "project = PROJ"
  },
  {
    "events": ["jira:issue_deleted"],
    "jqlFilter": "project IN (PROJ, EXP) AND status = done"
  },
  {
    "events": ["issue_property_set"],
    "issuePropertyKeysFilter": ["my-issue-property-key"],
    "jqlFilter": "project = PROJ"
  }
]
```


Download the attachment data connected to an issue

Get information and metadata of a board by Id

Example Project

scrum board

Get the information and metadata of the current user

Get the information and metadata of an issue

Get the information and metadata of a project

Get information and metadata about an user by id

Get the information and metadata of an existing version

Returns a list of users assignable to projects & issues

kanban board

sprint 1

sprint 2

Status Category Changed

Description

Summary

Next Version

List all webhooks configured, including those for other integrations

Search your entire Jira site using a JQL query 

Returns a list of issues that match the given string of text

Returns a list of projects that match the given string of text

Returns a single user that matches the given string of text

Update the contents and metadata of an existing comment.

Update an existing issue within a given project

While Jira's Cloud API has support for legacy OAuth 1.0, Prismatic only offers support for [Jira's OAuth 2.0 (3LO) flows](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/#enabling-oauth-2-0--3lo-).
If you select OAuth 2.0, you need to enable it for your app using the [Atlassian developer console](https://developer.atlassian.com/console).

1. Create a new "Oauth 2.0 integration" and give it a name.
1. Under the app details section, take note of your client Id and client secret values that were generated.
1. After you have saved those values, find the Authorization section and click configure on Oauth 2.0 (3LO).
1. You will now be prompted to enter your redirect URL as `https://oauth2.prismatic.io/callback` for US based integrations.
   1. For integrations outside the US refer to this [guide](https://prismatic.io/docs/connections/#creating-an-oauth-20-app-in-a-third-party-service) to find your region’s Callback URL. 
1. Next, navigate to the permissions. It is important that you remain consistent with the scopes you supply in both Jira, and your Prismatic connection.
1. The default scopes on a new connection in Prismatic will be as follows:
   1. `read:project:jira`
`read:user:jira`
`write:issue:jira`
`read:issue:jira`
`read:issue-link:jira`
`write:issue-link:jira`
`read:issue-link-type:jira`
`write:issue-link-type:jira`
`read:issue.transition:jira`
`delete:issue:jira`
   1. These scopes will provide access to the most of the actions in the Jira component, but you may have to modify the scopes in both locations (Prismatic and Atlassian Console) to meet your needs.
1.  For more information on developing Jira applications, follow the guide [here](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/).
1. Next, configure an OAuth 2.0 connection within Prismatic.
1. Add a Jira step to your integration.
   1. This will automatically create a Jira connection config variable.
1. Ensure the connection is of type `Jira OAuth 2.0 Connection` and enter the following details:
1. For **Client ID** and **Client Secret** enter the values that you got from the Atlassian Developer Console
1. As stated previously **Scopes** will default to the following:
   1. `read:project:jira`
    `read:user:jira`
    `write:issue:jira`
    `read:issue:jira`
    `read:issue-link:jira`
    `write:issue-link:jira`
    `read:issue-link-type:jira`
    `write:issue-link-type:jira`
    `read:issue.transition:jira`
    `delete:issue:jira`.
1. With the addition of `offline_access` on the connection side to obtain a refresh token. From here you can do any [additional configuration](https://developer.atlassian.com/cloud/jira/platform/scopes-for-connect-and-oauth-2-3LO-apps/#oauth-2-0-authorization-code-only-scopes) to match your use case. For example, you might assign the scopes `manage:jira-project read:jira-user` if you plan to work with Users and Projects. You will need to enable these scopes on the [Atlassian Developer Console](https://developer.atlassian.com/apps) page for your OAuth 2.0 Jira app. It is important to include `offline_access` in your scopes, or you will not be given a refresh token.
1. For **Version** enter the version of Jira you use (you likely use version **2**).
   1. Jira API: manage:jira-configuration, manage:jira-project, write:jira-work, read:jira-work.


If you select Basic Auth and you are using Jira Cloud, you will need to supply your Jira email and an API token to the connection.
If you are on a locally hosted instance of Jira, you will need to supply your Jira email and password to the connection.
For information on generating an API token from Jira Cloud, refer to the [Atlassian docs](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).


A map of a list of fields to Jira Issue Fields.

Manage Jira issues, comments, projects and users

[Jira](https://www.atlassian.com/software/jira) is a proprietary issue tracking product developed by Atlassian that allows bug tracking and agile project management.
This component allows you to create, update, comment on, and delete issues in a Jira project.

#### API Documentation
This component was built using the [JIRA API Documentation](https://developer.atlassian.com/server/jira/platform/rest-apis/)


Action Name	Action Description
Get Board	Get information and metadata of a board by Id
List Boards	Retrieve a list of existing boards
List Board Sprints	List all sprints within a board
Get Comments	Get all the comments on a given issue
Add Comment	Add a comment to an existing issue
Update Comment	Update the contents and metadata of an existing comment.
Delete Comment	Delete a comment from an issue
Search Issues	Returns a list of issues that match the given string of text
Get Issue	Get the information and metadata of an issue
Find Issue	Find Issue by attribute
List Issues	Returns a list of issues
Create Issue	Create an issue within a given project
Update Issue	Update an existing issue within a given project
Delete Issue	Delete an issue by id
Download Issue Attachment	Download the attachment data connected to an issue
List Issue Transitions	Returns a list of issue transitions
List Issue Worklogs	Returns a list of issue worklogs
Transition Issue	Transition an existing issue by Id
Add Issue Attachment	Add a file attachment to an issue
Find Project	Find Project by attribute
Get Project	Get the information and metadata of a project
List Projects	Retrieve a list of all projects
Search Projects	Returns a list of projects that match the given string of text
Search Users	Returns a single user that matches the given string of text
Get Current User	Get the information and metadata of the current user
List Assignable Users	Returns a list of users assignable to projects & issues
Find User	Find User by attribute
Get User	Get information and metadata about an user by id
Create User	Create a new user record
Query	Search your entire Jira site using a JQL query
Get Status List	Returns a status list
List Issue Fields	List all non-custom issue fields
List Issue Custom Fields	List all configured issue fields
List Issue Link Types	List all available issue link types
List Issue Types	Returns a list of issue types
List Priorities	Returns a list of all priorities
Get Version	Get the information and metadata of an existing version
List Versions	Returns a list of all versions
Create Version	Create a new version
Update Version	Update an existing version by Id
List Webhooks	List all webhooks configured, including those for other integrations
Create Webhook	Create a webhook to send data from Jira to an instance URL
Delete Webhook	Delete a webhook by ID
Refresh Webhook	Refresh webhook expiration by ID
Raw Request	Send raw HTTP request to Jira

Jira Connector

Integrate with customers’ other SaaS apps, fast

About the Jira Connector

Actions

Triggers

Ready to get started?