Versions Compared

Old Version 2

changes.mady.by.user Megan Storie

Saved on

compared with

New Version Current

changes.mady.by.user Megan Storie

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

This document lists all the CLI Commands that can be used with Integration + for Slack.

On this page:

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledisc
typelist
printabletrue

Command

Condition

Where it can be triggered

Example

Behavior

Ticket mention

Condition:

A message contains an issue key; the position in the message is not important.

Where can be triggered:

everywhere

Example:

please test TCM-1

Behavior:

We send a message with issue details.

Add an attachment

Condition:

The message is attach {issue key} .

Where can be triggered:

everywhere

Example:

attach TCM-1

Behavior:

If the message did not include an attachment, we will send you a message noting that. If the message contains an attachment, we will attach the file to the issue and leave a comment.

Quick create (without project and issue type)

Condition:

The message starts with quick create {summary} and the channel has a quick create configuration with project and issue type.

Where can be triggered:

everywhere

Example:

quick create test summary

Behavior:

If the channel doesn’t have both project and type configured for quick creation, we send the configured channel an ephemeral message. Otherwise, the issue will be created.

On this page:

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledisc
typelist
printabletrue

Create

For creating issues immediately.

Condition:

The message starts with create {issue type} {project key} {summary} {additional fields}

.

Where can be triggered:

everywhere

Example:

create Task TCM Here’s the summary +description And the description +priority Low +labels A

Behavior:

If the message is correctly formatted, an issue will be created, and we will post the issue details in the thread. If any parameters are incorrectly formatted, the command will not post a message.

Currently, field names must be in lowercase.

Create issue

For viewing the Create Screen before creation.

Condition: the

The message starts with create issue {project key} {summary} or create ticket {project key} {summary} .

Where can be triggered:

everywhere

Example:

create ticket TCM Summary here

Behavior:

Jira Integration+ will respond with a Create Issue button. If used without a project key and/or summary, those can be set after clicking Create Issue. Also, if no project key or summary is entered, we will take the values from the channel’s quick-create configuration.

Creation help

Condition:

The message starts with create help {project key} .

Where can be triggered:

everywhere

Example:

create help TCM

Behavior:

We send a message in the thread with an example and create commands for this project.

Quick create (with project and issue type)

Condition:

The message starts with quick create-{issue type}-{project key} {summary} .

Where can be triggered:

everywhere

Example:

quick create-task-TCM example summary

Behavior:

If everything is correct, we create the issue and send the issue details.

Quick create (with issue type only)

Condition:

The message starts with quick create-{issue type} {summary}

.

Where can be triggered:

everywhere

Example:

quick create-task example summary

Behavior:

If no project is configured in the channel’s quick create settings, we will send you the channel configuration button. If the channel has a project configured, we will create the issue and send the issue details.

Assign

Condition:

The message is assign {issue key} {slack user mention} .

Where can be triggered:

everywhere

Example:

assign TCM-1 @user

Behavior:

This command reassigns the issue to the associated Jira user.

Edit help

Condition:

The message starts with edit help {issue key} or update help {issue key} .

Where can be triggered:

everywhere

Example:

edit help TCM-1

Behavior:

This command sends a message that lists all the fields that can be edited on the issue, including custom fields, which will appear in the customfield_10058 format.

Edit

Condition:

The message starts with edit {issue key} +{field to update} or update {issue key} +{field to update} .

Where can be triggered:

everywhere

Example:

edit TCM-1 +summary test summary +customfield_10058 100

Behavior:

This command updates the issue and sends the issue details.

Comment

Condition:

The message starts with comment {issue key} {text} .

Where can be triggered:

everywhere

Example:

comment TCM-1 new comment

Behavior:

This command adds the comment to the issue and sends the issue details.

Watcher

Condition:

The message starts with watch {issue key} .

Where can be triggered:

everywhere

Example:

watch TCM-1

Behavior:

This command adds the user as a watcher and sends the issue details.

Capture

Condition:

The message is capture or jira capture .

Where can be triggered:

threads only

Example:

capture

Behavior:

This command provides a message that presents the capture options.

Vote

Condition:

The message is vote {issue key} .

Where can be triggered:

everywhere

Example:

vote TCM-1

Behavior:

This command votes for an issue, then sends the issue details.

Votes

Condition:

The message is votes {issue key} .

Where can be triggered:

everywhere

Example:

votes TCM-1

Behavior:

This command shows the users who have voted for the issue.

Worklog

Condition:

The message is log {time} {issue key} or add {time} {issue key} .

Where can be triggered:

everywhere

Example:

log 1d 15m TCM-1

Behavior:

This command logs time on the issue and sends a confirmation message.

Condition:

The message is jira search {jql} or jql search {jql} .

Where can be triggered:

everywhere

Example:

jira search project=TCM

Behavior:

This command gives us a list of the JQL query’s result.

Simple search

Condition:

The message is jira find {text} .

Where can be triggered:

everywhere

Example:

jira find test

Behavior:

This command runs the JQL search text ~ [value] and sends the list of issues found.

Filter

Condition:

The message is jira filter {filter name} .

Where can be triggered:

everywhere

Example:

jira filter Name

Behavior:

This command sends a list of issues present in the named filter.

Project search

Condition:

The message is project {project key} .

Where can be triggered:

everywhere

Example:

project TCM

Behavior:

This command provides a list of issues from the specified project.

Project search by assignee

Condition:

The message starts with project {project key} {assignee username or jira id} .

Where can be triggered:

everywhere

Example:

project TCM 639885d077c9c3a008b90913

Behavior:

This command provides a list of issues from the specified project with specified assignee.

Pastdue

Condition:

The message is pastdue {project key} or overdue {project key} .

Where can be triggered:

everywhere

Example:

pastdue TCM

Behavior:

This command provides a list of issues with a Due date before today's date.

Current sprint

Condition:

The message is sprint current {project key} or current sprint {project key} .

Where can be triggered:

everywhere

Example:

sprint current TCM

Behavior:

This command provides a list of issues in the selected project that are on an active sprint.

Sprint

Condition:

The message starts with sprint {sprint name} .

Where can be triggered:

everywhere

Example:

sprint blue sprint

Behavior:

This command provides a list of issues in the specified sprint.

Find issues assigned to

Condition:

The message is tickets {assignee jira id} or issues {assignee jira id} .

Where can be triggered:

everywhere

Example:

tickets 639885d077c9c3a008b90913

Behavior:

This command provides a list of issues with the specified assignee.

Find issues assigned to me

Condition:

The message is my issues or my tickets .

Where can be triggered:

everywhere

Example:

my issues

Behavior:

This command provides a list of issues of the current user.

Auth

Condition:

The message is auth.

Where can be triggered:

everywhere

Example:

auth

Behavior:

This command provides a message allowing the user to authetnicate to Jira.

Configure

Condition:

The message is jira configure .

Where can be triggered:

everywhere

Example:

jira configure

Behavior:

This command sends the channel configuration message.

Help

Condition:

The message is help .

Where can be triggered:

everywhere

Example:

help

Behavior:

This action provides a list of commands.

Nextup debug info

Condition:

The message is nextup:debug:info .

Where can be triggered:

everywhere

Example:

nextup:debug:info

Behavior:

Shows info about the connected bot.