← Jira

Add Comment To Issue with Jira API

Pipedream makes it easy to connect APIs for Jira and 2,400+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Add Comment To Issue with the Jira API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Add Comment To Issue with the Jira API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Add Comment To Issue action
    1. Connect your Jira account
    2. Select a Cloud ID
    3. Select a Issue id or key
    4. Configure Body
    5. Optional- Configure Visibility
    6. Optional- Configure Properties
    7. Optional- Configure Additional properties
    8. Optional- Configure Expand
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Add Comment To Issue with Jira API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Jira
 
Try it
Add Comment To Issue with Jira API on New Item in Feed from RSS API
RSS + Jira
 
Try it
Add Comment To Issue with Jira API on New Message from Discord API
Discord + Jira
 
Try it
Add Comment To Issue with Jira API on New Message In Channels from Slack API
Slack + Jira
 
Try it
Add Comment To Issue with Jira API on New Message in Channel from Discord Bot API
Discord Bot + Jira
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Add Comment To Issue on Jira
Description:Adds a new comment to an issue, [See the docs](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/#api-rest-api-3-issue-issueidorkey-comment-post)
Version:0.1.9
Key:jira-add-comment-to-issue

Code

import utils from "../../common/utils.mjs";
import jira from "../../jira.app.mjs";

export default {
  key: "jira-add-comment-to-issue",
  name: "Add Comment To Issue",
  description: "Adds a new comment to an issue, [See the docs](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/#api-rest-api-3-issue-issueidorkey-comment-post)",
  version: "0.1.9",
  type: "action",
  props: {
    jira,
    cloudId: {
      propDefinition: [
        jira,
        "cloudId",
      ],
    },
    issueIdOrKey: {
      propDefinition: [
        jira,
        "issueIdOrKey",
        (c) => ({
          cloudId: c.cloudId,
        }),
      ],
    },
    body: {
      type: "object",
      label: "Body",
      description: "The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/), e.g. `{\"type\":\"doc\",\"version\":1,\"content\":[{\"content\":[{\"text\":\"This is a comment\",\"type\":\"text\"}],\"type\":\"paragraph\"}]}`",
    },
    visibility: {
      type: "object",
      label: "Visibility",
      description: "The group or role to which this comment is visible, See `Visibility` section of [doc](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/#api-rest-api-3-issue-issueidorkey-comment-post)",
      optional: true,
    },
    properties: {
      propDefinition: [
        jira,
        "properties",
      ],
      description: "A list of comment properties.",
    },
    additionalProperties: {
      propDefinition: [
        jira,
        "additionalProperties",
      ],
    },
    expand: {
      propDefinition: [
        jira,
        "expand",
      ],
      description: "The Jira REST API uses resource expansion, which means that some parts of a resource are not returned unless specified in the request. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.",
    },
  },
  async run({ $ }) {
    const visibility = utils.parseObject(this.visibility);
    const body = utils.parseObject(this.body);
    const additionalProperties = utils.parseObject(this.additionalProperties);
    let properties;
    try {
      properties = JSON.parse(this.properties);
    } catch ( err ) {
      //pass
    }
    const response = await this.jira.addCommentToIssue({
      $,
      cloudId: this.cloudId,
      issueIdOrKey: this.issueIdOrKey,
      params: {
        expand: this.expand,
      },
      data: {
        body,
        visibility,
        properties,
        ...additionalProperties,
      },
    });
    $.export("$summary", `Comment has been added to the issue with ID(or key): ${this.issueIdOrKey}`);
    return response;

  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
JirajiraappThis component uses the Jira app.
Cloud IDcloudIdstringSelect a value from the drop down menu.
Issue id or keyissueIdOrKeystringSelect a value from the drop down menu.
Bodybodyobject

The comment text in Atlassian Document Format, e.g. {"type":"doc","version":1,"content":[{"content":[{"text":"This is a comment","type":"text"}],"type":"paragraph"}]}

Visibilityvisibilityobject

The group or role to which this comment is visible, See Visibility section of doc

Propertiespropertiesstring

A list of comment properties.

Additional propertiesadditionalPropertiesobject

Extra properties of any type may be provided to this object.

Expandexpandstring

The Jira REST API uses resource expansion, which means that some parts of a resource are not returned unless specified in the request. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

Authentication

Jira uses OAuth authentication. When you connect your Jira account, Pipedream will open a popup window where you can sign into Jira and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Jira API.

Pipedream requests the following authorization scopes when you connect your account:

read:jira-workmanage:jira-projectread:jira-userwrite:jira-workmanage:jira-data-providerread:meoffline_accessread:issue-details:jiraread:board-scope:jira-softwareread:webhook:jirawrite:webhook:jiraread:field:jiraread:project:jiradelete:webhook:jirawrite:board-scope:jira-softwareread:board-scope.admin:jira-softwareread:sprint:jira-softwarewrite:sprint:jira-softwareread:field.option:jirawrite:field.option:jiraread:custom-field-contextual-configuration:jira write:custom-field-contextual-configuration:jiramanage:jira-configurationread:jql:jira

About Jira

Jira is the #1 agile project management tool used by teams to plan, track, release, and support great software with confidence

More Ways to Use Jira

Triggers

New Event from the Jira API

Emit new event when an event with subscribed event source triggered, See the docs

 
Try it
New Issue Created Event (Instant) from the Jira API

Emit new event when an issue is created. Note that Jira supports only one webhook, if more sources are needed please use New Event source and select multiple events.

 
Try it
New Issue Deleted Event (Instant) from the Jira API

Emit new event when an issue is deleted. Note that Jira supports only one webhook, if more sources are needed please use New Event source and select multiple events.

 
Try it
New Issue Updated Event (Instant) from the Jira API

Emit new event when an issue is updated. Note that Jira supports only one webhook, if more sources are needed please use New Event source and select multiple events.

 
Try it

Actions

Add Attachment To Issue with the Jira API

Adds an attachment to an issue, See the docs

 
Try it
Add Multiple Attachments To Issue with the Jira API

Adds multiple attachments to an issue, See the docs

 
Try it
Add Watcher To Issue with the Jira API

Adds a user as a watcher of an issue by passing the account ID of the user, For example, 5b10ac8d82e05b22cc7d4ef5, If no user is specified the calling user is added. See the docs

 
Try it
Assign Issue with the Jira API

Assigns an issue to a user. See the docs

 
Try it
Create Custom Field Options (Context) with the Jira API

Create a context for custom field options. See the documentation here.

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.