Jump to a Section

Events

  • WebhookNewComment

    Webhook New Comment

    NOTE: The account you authenticated for JIRA must have global admin permissions in JIRA in order to use this webhook event.

    Waits to receive an incoming request from JIRA containing information on new comments. This request occurs whenever a comment is added to an issue in JIRA and will trigger the Flow immediately.

    Options

    • Project (dropdown): A list of your projects in JIRA

    Output Fields

    • Issue
      • Issue ID (text): ID of the issue the comment was added to
      • Issue Key (text): Key of the issue the comment was added to
    • Comment
      • Comment ID (text): ID of the new comment
      • URL (text): weblink of the new comment
      • Body (text): body of the new comment
      • Author ID (text): ID of the author of the new comment
      • CreatedDate (text): date the comment was created

Actions

  • searchUsers

    Add Issue to Sprint

    Adds an existing issue to a Sprint in JIRA.

    Input Fields

    • Sprint
      • Sprint ID (text): The ID of the sprint you want to add to.
    • Issues
      • Issue IDs or Keys (list of text): Either the ID or the Key of the issues you wish to add to the sprint. The key can be found in the URL of the Issue (https://yourdomain.atlassian.net/projects/HT/issues/**HT-22** where HT is the Project Key). You can find the Issue ID by using the Key to search in ‘Read Issue’. They are also both given when an issue is created in the designer by using ‘Create Issue’.

    Output Fields

    • There are no output fields for this card.
  • AttachFileToIssue

    Attach File to Issue

    Attach a file to any issue in your JIRA account.

    Input Fields

    • Issue ID or Key (text): The issue ID or Key of the Issue that a file is being attached to.
    • File Content (File): The file that you are attaching to the Issue.

    Output Fields

    • Attachment ID (text): This output is the new attachment ID of the file that has been attached.
  • CreateComment

    Create Comment

    Use this card to create a comment on an issue inside of JIRA. You are able to set the security level of the comment if necessary.

    Input Fields

    • Issue

      • ID (text): This is the unique ID of the JIRA issue you want to add the comment to.
    • Comment

      • Body (text): The text of the comment you wish to add to the specific JIRA issue
      • Visibility_Type (text): The type of visibility you wish this comment to be visible at (example: role, project, etc. ). This field is optional.
      • Visibility_Level (text): The level of visibility you wish to specify based on the type. (Example: if you selected role for visibility type you could use administrator). This field is optional.
  • ListIssues

    List Issues

    List all the issues from any or all Projects or Issue Types selected in the Options menu.

    Options

    • Project (dropdown): list of your projects in JIRA; choose the project to search; select “–All Projects–” to search across all projects
    • Issue Type (dropdown): list of issues types; choose the issue type to search; select “–All Issue Types–” to search across all issue types

    Output Fields

    The output of List Issues will be a list object of all the issues from the Project(s) and Issue Type(s) chosen.

  • ReadIssue

    Read Issue

    Read information about a specific issue in JIRA.

    Options

    • Project (dropdown): list of your projects in JIRA; choose the project to search; select “–All Projects–” to search across all projects
    • Issue Type (dropdown): list of issues types; choose the issue type to search; select “–All Issue Types–” to search across all issue types

    Input Fields

    • fields
      • issueIdOrKey (text): the issue ID or key (e.g. ACB-63)

    Output Fields

    The output of Read Issue will allow you to select any associated field of the issue you are reading (standard and custom fields). If there is no value in a field at the time that this step in a Flow is running, it will return a blank value.

  • searchissuesbyjql

    Search Issues by JQL

    This action lets you search JIRA issues using a JQL (JIRA query language) query. You can read more about JQL here.

    Input Fields

    • Search By
      • JQL Query (text):The JQL query you would like to execute.  Example: project = “ABC” AND (assignee = “Flo” OR assignee = currentUser())
      • Limit (number): The number of records you would like your query to return. If you specify a limit higher than the maximum allowable number of search results for your instance, your search results will be truncated.
      • Offset (number): The number of records to offset your search by. For example, if you choose to offset your search by 100, the search  results will not include the first 99 records found and instead start the results at the 100th record found. Useful for paginating through large search results.

    Output Fields

    • Result
      • Issues (list of objects): A list of objects, each one representing a single issue.
        • Key (text): The key of the issue.
        • ID (text): The ID of the issue.
        • URL (text): The URL of the issue.
  • TransitionIssue

    Transition Issue

    Transition an issue inside JIRA from one status to another.

    Input Fields

    • Fields
      • issueIdOrKey (text): the issue ID or key (e.g. ACB-63)
      • transitionKeyOrId (text): the key or ID of the transition that the issue is going to undertake
      • comment (text): attach a comment to the transition of the issue