{"action":"created","comment":{"url":"https://api.github.com/repos/workato/docs/pulls/comments/188242585","pull_request_review_id":120177732,"id":188242585,"diff_hunk":"@@ -0,0 +1,266 @@\n+---\n+title: Configuring slash commands\n+date: 2018-04-9 10:23:00 Z\n+---\n+\n+# Configuring a slash command\n+Slash commands are a great way to trigger Workbot Post command triggers.\n+\n+![Slash command in Slack](/assets/images/workbot/workbot-slash-commands/slash-command-in-slack.png)\n+\n+There are 2 methods you can configure slash commands; by connecting a [custom Workbot](#slash-command-using-custom-bots), or by a [legacy custom integration](#legacy-slash-commands).\n+\n+We strongly recommend using custom Workbots to configure your slash command, as custom integration is a legacy method that will eventually be deprecated (no news as to when just yet).\n+\n+## Slash command using custom bots\n+To use this method, you first need to [create a custom bot](/workbot/workbot-custom-bots.md).\n+\n+These slash commands must be added and configured under a custom bot in Slack before they can be used in Workato.\n+\n+If you already have a custom Workbot, proceed on to learn how to configure slash commands with your custom bot.\n+\n+#### Workbot connection\n+To use slash commands using a custom Workbot, you need to connect its custom OAuth profile to the Workbot connection like so:\n+\n+![Connect custom OAuth profile](/assets/images/workbot/workbot-slash-commands/custom-oauth-workbot-connection.png)\n+\n+If you don't have a custom Workbot with a custom OAuth profile, check out this [this guide](/workbot/workbot-custom-bots.md) on how to configure a custom Workbot.\n+\n+#### Configuring the slash command\n+\n+Slash commands can be configured in Workbot Post command triggers, under the **Slash command configuration** group.\n+\n+![Slash command configuration.png](/assets/images/workbot/workbot-slash-commands/slash-command-configuration.png)\n+\n+The table below shows the input schema for the slash command configuration fields.\n+\n+<table class=\"unchanged rich-diff-level-one\">\n+    <thead>\n+        <tr>\n+            <th>Field</th>\n+            <th>Explanation</th>\n+            <th>What goes in here</th>\n+        </tr>\n+    </thead>\n+    <tbody>\n+        <tr>\n+          <td>Enable Slash command</td>\n+          <td>Toggle whether to enable slash command for this command trigger.</td>\n+          <td>\n+            If set to 'Yes', command can be invoked using slash command.\n+          </td>\n+        </tr>\n+        <tr>\n+          <td>Command name</td>\n+          <td>\n+            Used to invoke the slash command.\n+          </td>\n+          <td>\n+          What user will key in in Slack to invoke this slash command. Must begin with '/' and contain no spaces e.g. /createissue<br><br>In Slack, copy & paste this into the <b>Command</b> field in the slash command of your custom bot.\n+          </td>\n+        </tr>\n+        <tr>\n+          <td>Auto-reply message</td>\n+          <td>\n+            When command is invoked, automatically sends this reply to the user only. If left empty, reply will mirror the user's command.\n+          </td>\n+          <td>\n+            Key in some text to assure user that the command was received after invocation e.g. <code>\"Command received, working...\"</code>\n+          </td>\n+        </tr>\n+        <tr>\n+          <td>Dialog for missing command input fields</td>\n+          <td>\n+            Show a dialog to collect command input fields from the user.\n+          </td>\n+          <td>\n+            If 'Yes', missing command input fields can be entered in a dialog form. Otherwise, Workbot will prompt for them in conversation with user.<br><br>Can only be used when command is invoked using a custom bot slash command.\n+          </td>\n+        </tr>\n+    </tbody>\n+</table>\n+\n+\n+## Getting started\n+To get started, fill in the post command trigger fields as you normally would. Next, move on to the slash command configuration group.\n+\n+### Slash command configuration group\n+\n+#### Enable slash command\n+Toggle whether to enable slash command for this command trigger.\tWhen set to 'Yes', command can be invoked using a slash command.\n+\n+![Enable slash command](/assets/images/workbot/workbot-slash-commands/enable-slash-command.png)\n+\n+#### Command name\n+This is the name of your slash command. Slash commands should be named after the function it performs, e.g.\n+\n+<code>/createissue, /listusers, /showcustomers</code>\n+\n+Slash command actions must start with a slash and contain no spaces. This slash command will also need to be created in your custom bot in Slack, but we'll get to that later.\n+\n+![Slash command name example](/assets/images/workbot/workbot-slash-commands/slash-command-name.png)\n+\n+#### Request URL\n+When slash commands are invoked from Slack, Slack will require a URL to send requests to. This request URL is generated by Workato, and will be needed when setting up your slash command in Slack (we'll get to that later).\n+\n+After **Enable slash command** is set to **Yes**, and a valid **Command name** is keyed in, then a **Request URL** is generated in the help box at the top of the post command trigger.\n+\n+![Request URL](/assets/images/workbot/workbot-slash-commands/request-url.png)\n+\n+#### Dialog for missing command input fields\n+When set to 'Yes', this triggers a dialog to pop up when the user invokes the command via a Slash command. This dialog collects all the command input fields you require from the user. Hints and examples defined in the command input fields are also displayed in the form.","path":"workbot/configuring-slash-commands.md","position":111,"original_position":111,"commit_id":"82be99b794bf58636b1e3fe1fe5de9afeb487440","original_commit_id":"82be99b794bf58636b1e3fe1fe5de9afeb487440","user":{"login":"jandonyada","id":14304570,"avatar_url":"https://avatars3.githubusercontent.com/u/14304570?v=4","gravatar_id":"","url":"https://api.github.com/users/jandonyada","html_url":"https://github.com/jandonyada","followers_url":"https://api.github.com/users/jandonyada/followers","following_url":"https://api.github.com/users/jandonyada/following{/other_user}","gists_url":"https://api.github.com/users/jandonyada/gists{/gist_id}","starred_url":"https://api.github.com/users/jandonyada/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jandonyada/subscriptions","organizations_url":"https://api.github.com/users/jandonyada/orgs","repos_url":"https://api.github.com/users/jandonyada/repos","events_url":"https://api.github.com/users/jandonyada/events{/privacy}","received_events_url":"https://api.github.com/users/jandonyada/received_events","type":"User","site_admin":false},"body":"> It is not directly obvious that it is one of the other here.\r\nHmm not sure what you mean here. Also, what do you have in mind for the table?","created_at":"2018-05-15T10:45:25Z","updated_at":"2018-05-15T10:45:25Z","html_url":"https://github.com/workato/docs/pull/465#discussion_r188242585","pull_request_url":"https://api.github.com/repos/workato/docs/pulls/465","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/workato/docs/pulls/comments/188242585"},"html":{"href":"https://github.com/workato/docs/pull/465#discussion_r188242585"},"pull_request":{"href":"https://api.github.com/repos/workato/docs/pulls/465"}},"in_reply_to_id":188184879},"pull_request":{"url":"https://api.github.com/repos/workato/docs/pulls/465","id":187842035,"html_url":"https://github.com/workato/docs/pull/465","diff_url":"https://github.com/workato/docs/pull/465.diff","patch_url":"https://github.com/workato/docs/pull/465.patch","issue_url":"https://api.github.com/repos/workato/docs/issues/465","number":465,"state":"open","locked":false,"title":"Slash command guides","user":{"login":"jandonyada","id":14304570,"avatar_url":"https://avatars3.githubusercontent.com/u/14304570?v=4","gravatar_id":"","url":"https://api.github.com/users/jandonyada","html_url":"https://github.com/jandonyada","followers_url":"https://api.github.com/users/jandonyada/followers","following_url":"https://api.github.com/users/jandonyada/following{/other_user}","gists_url":"https://api.github.com/users/jandonyada/gists{/gist_id}","starred_url":"https://api.github.com/users/jandonyada/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jandonyada/subscriptions","organizations_url":"https://api.github.com/users/jandonyada/orgs","repos_url":"https://api.github.com/users/jandonyada/repos","events_url":"https://api.github.com/users/jandonyada/events{/privacy}","received_events_url":"https://api.github.com/users/jandonyada/received_events","type":"User","site_admin":false},"body":"**DO NOT MERGE UNTIL WORKBOT SLASH COMMANDS IS LIVE, ETA 19 May 2018** https://github.com/workato/workato/tree/workbot_slash_commands\r\n","created_at":"2018-05-14T14:16:41Z","updated_at":"2018-05-15T10:45:25Z","closed_at":null,"merged_at":null,"merge_commit_sha":"543e1b477e2d9824c34156103ce89ddf07ada508","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/workato/docs/pulls/465/commits","review_comments_url":"https://api.github.com/repos/workato/docs/pulls/465/comments","review_comment_url":"https://api.github.com/repos/workato/docs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/workato/docs/issues/465/comments","statuses_url":"https://api.github.com/repos/workato/docs/statuses/82be99b794bf58636b1e3fe1fe5de9afeb487440","head":{"label":"workato:slash-command-guides","ref":"slash-command-guides","sha":"82be99b794bf58636b1e3fe1fe5de9afeb487440","user":{"login":"workato","id":5629924,"avatar_url":"https://avatars3.githubusercontent.com/u/5629924?v=4","gravatar_id":"","url":"https://api.github.com/users/workato","html_url":"https://github.com/workato","followers_url":"https://api.github.com/users/workato/followers","following_url":"https://api.github.com/users/workato/following{/other_user}","gists_url":"https://api.github.com/users/workato/gists{/gist_id}","starred_url":"https://api.github.com/users/workato/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/workato/subscriptions","organizations_url":"https://api.github.com/users/workato/orgs","repos_url":"https://api.github.com/users/workato/repos","events_url":"https://api.github.com/users/workato/events{/privacy}","received_events_url":"https://api.github.com/users/workato/received_events","type":"Organization","site_admin":false},"repo":{"id":82145434,"name":"docs","full_name":"workato/docs","owner":{"login":"workato","id":5629924,"avatar_url":"https://avatars3.githubusercontent.com/u/5629924?v=4","gravatar_id":"","url":"https://api.github.com/users/workato","html_url":"https://github.com/workato","followers_url":"https://api.github.com/users/workato/followers","following_url":"https://api.github.com/users/workato/following{/other_user}","gists_url":"https://api.github.com/users/workato/gists{/gist_id}","starred_url":"https://api.github.com/users/workato/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/workato/subscriptions","organizations_url":"https://api.github.com/users/workato/orgs","repos_url":"https://api.github.com/users/workato/repos","events_url":"https://api.github.com/users/workato/events{/privacy}","received_events_url":"https://api.github.com/users/workato/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/workato/docs","description":null,"fork":false,"url":"https://api.github.com/repos/workato/docs","forks_url":"https://api.github.com/repos/workato/docs/forks","keys_url":"https://api.github.com/repos/workato/docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/workato/docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/workato/docs/teams","hooks_url":"https://api.github.com/repos/workato/docs/hooks","issue_events_url":"https://api.github.com/repos/workato/docs/issues/events{/number}","events_url":"https://api.github.com/repos/workato/docs/events","assignees_url":"https://api.github.com/repos/workato/docs/assignees{/user}","branches_url":"https://api.github.com/repos/workato/docs/branches{/branch}","tags_url":"https://api.github.com/repos/workato/docs/tags","blobs_url":"https://api.github.com/repos/workato/docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/workato/docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/workato/docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/workato/docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/workato/docs/statuses/{sha}","languages_url":"https://api.github.com/repos/workato/docs/languages","stargazers_url":"https://api.github.com/repos/workato/docs/stargazers","contributors_url":"https://api.github.com/repos/workato/docs/contributors","subscribers_url":"https://api.github.com/repos/workato/docs/subscribers","subscription_url":"https://api.github.com/repos/workato/docs/subscription","commits_url":"https://api.github.com/repos/workato/docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/workato/docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/workato/docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/workato/docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/workato/docs/contents/{+path}","compare_url":"https://api.github.com/repos/workato/docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/workato/docs/merges","archive_url":"https://api.github.com/repos/workato/docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/workato/docs/downloads","issues_url":"https://api.github.com/repos/workato/docs/issues{/number}","pulls_url":"https://api.github.com/repos/workato/docs/pulls{/number}","milestones_url":"https://api.github.com/repos/workato/docs/milestones{/number}","notifications_url":"https://api.github.com/repos/workato/docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/workato/docs/labels{/name}","releases_url":"https://api.github.com/repos/workato/docs/releases{/id}","deployments_url":"https://api.github.com/repos/workato/docs/deployments","created_at":"2017-02-16T06:04:38Z","updated_at":"2018-05-14T05:17:08Z","pushed_at":"2018-05-14T23:13:03Z","git_url":"git://github.com/workato/docs.git","ssh_url":"git@github.com:workato/docs.git","clone_url":"https://github.com/workato/docs.git","svn_url":"https://github.com/workato/docs","homepage":null,"size":319446,"stargazers_count":1,"watchers_count":1,"language":"HTML","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":8,"mirror_url":null,"archived":false,"open_issues_count":135,"license":null,"forks":8,"open_issues":135,"watchers":1,"default_branch":"master"}},"base":{"label":"workato:master","ref":"master","sha":"7552d587a68da34de90c14d27147ea254e7fbbe5","user":{"login":"workato","id":5629924,"avatar_url":"https://avatars3.githubusercontent.com/u/5629924?v=4","gravatar_id":"","url":"https://api.github.com/users/workato","html_url":"https://github.com/workato","followers_url":"https://api.github.com/users/workato/followers","following_url":"https://api.github.com/users/workato/following{/other_user}","gists_url":"https://api.github.com/users/workato/gists{/gist_id}","starred_url":"https://api.github.com/users/workato/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/workato/subscriptions","organizations_url":"https://api.github.com/users/workato/orgs","repos_url":"https://api.github.com/users/workato/repos","events_url":"https://api.github.com/users/workato/events{/privacy}","received_events_url":"https://api.github.com/users/workato/received_events","type":"Organization","site_admin":false},"repo":{"id":82145434,"name":"docs","full_name":"workato/docs","owner":{"login":"workato","id":5629924,"avatar_url":"https://avatars3.githubusercontent.com/u/5629924?v=4","gravatar_id":"","url":"https://api.github.com/users/workato","html_url":"https://github.com/workato","followers_url":"https://api.github.com/users/workato/followers","following_url":"https://api.github.com/users/workato/following{/other_user}","gists_url":"https://api.github.com/users/workato/gists{/gist_id}","starred_url":"https://api.github.com/users/workato/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/workato/subscriptions","organizations_url":"https://api.github.com/users/workato/orgs","repos_url":"https://api.github.com/users/workato/repos","events_url":"https://api.github.com/users/workato/events{/privacy}","received_events_url":"https://api.github.com/users/workato/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/workato/docs","description":null,"fork":false,"url":"https://api.github.com/repos/workato/docs","forks_url":"https://api.github.com/repos/workato/docs/forks","keys_url":"https://api.github.com/repos/workato/docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/workato/docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/workato/docs/teams","hooks_url":"https://api.github.com/repos/workato/docs/hooks","issue_events_url":"https://api.github.com/repos/workato/docs/issues/events{/number}","events_url":"https://api.github.com/repos/workato/docs/events","assignees_url":"https://api.github.com/repos/workato/docs/assignees{/user}","branches_url":"https://api.github.com/repos/workato/docs/branches{/branch}","tags_url":"https://api.github.com/repos/workato/docs/tags","blobs_url":"https://api.github.com/repos/workato/docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/workato/docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/workato/docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/workato/docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/workato/docs/statuses/{sha}","languages_url":"https://api.github.com/repos/workato/docs/languages","stargazers_url":"https://api.github.com/repos/workato/docs/stargazers","contributors_url":"https://api.github.com/repos/workato/docs/contributors","subscribers_url":"https://api.github.com/repos/workato/docs/subscribers","subscription_url":"https://api.github.com/repos/workato/docs/subscription","commits_url":"https://api.github.com/repos/workato/docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/workato/docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/workato/docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/workato/docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/workato/docs/contents/{+path}","compare_url":"https://api.github.com/repos/workato/docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/workato/docs/merges","archive_url":"https://api.github.com/repos/workato/docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/workato/docs/downloads","issues_url":"https://api.github.com/repos/workato/docs/issues{/number}","pulls_url":"https://api.github.com/repos/workato/docs/pulls{/number}","milestones_url":"https://api.github.com/repos/workato/docs/milestones{/number}","notifications_url":"https://api.github.com/repos/workato/docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/workato/docs/labels{/name}","releases_url":"https://api.github.com/repos/workato/docs/releases{/id}","deployments_url":"https://api.github.com/repos/workato/docs/deployments","created_at":"2017-02-16T06:04:38Z","updated_at":"2018-05-14T05:17:08Z","pushed_at":"2018-05-14T23:13:03Z","git_url":"git://github.com/workato/docs.git","ssh_url":"git@github.com:workato/docs.git","clone_url":"https://github.com/workato/docs.git","svn_url":"https://github.com/workato/docs","homepage":null,"size":319446,"stargazers_count":1,"watchers_count":1,"language":"HTML","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":8,"mirror_url":null,"archived":false,"open_issues_count":135,"license":null,"forks":8,"open_issues":135,"watchers":1,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/workato/docs/pulls/465"},"html":{"href":"https://github.com/workato/docs/pull/465"},"issue":{"href":"https://api.github.com/repos/workato/docs/issues/465"},"comments":{"href":"https://api.github.com/repos/workato/docs/issues/465/comments"},"review_comments":{"href":"https://api.github.com/repos/workato/docs/pulls/465/comments"},"review_comment":{"href":"https://api.github.com/repos/workato/docs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/workato/docs/pulls/465/commits"},"statuses":{"href":"https://api.github.com/repos/workato/docs/statuses/82be99b794bf58636b1e3fe1fe5de9afeb487440"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"jandonyada"}}