Slack向けWorkbotトリガー

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

Workbot for Slackを使用すると、Slack上のWorkbotにコマンドを送信できます。 Workbotはこれらのコマンドを処理し、接続済みアプリと連携して、顧客アカウントの詳細表示、商談のクローズ、請求書やチケットの一覧表示、既存チケットの作成/更新などを実行します。

各Workbotコマンドは、Workatoレシピを使用して処理されます。 レシピトリガーはWorkbotコマンドをトリガーイベントとして取得し、レシピが実行するアクションを決定します。 Workbotを使用すると、Slackコマンドを通じて実行されるカスタムワークフローを作成し、必要に応じて関連データをSlackに取得できます。

Workbot for Slackコネクタには5つのトリガーがあります。

New commandトリガー(カスタムコマンドの構築)

このトリガーでは、カスタムWorkbotコマンドを設定します。 このトリガーを含むレシピが開始されると、Workbotは新しいコマンドを監視します。 呼び出されると、Workbotはレシピアクションの実行を続行します。

New commandトリガー入力フィールド

次の表に、トリガーで設定可能な入力フィールドと、各フィールドの機能を示します。

New commandトリガー入力フィールド説明
アプリ Workbotコマンドの1番目の部分。 Workbotコマンドが操作するアプリ。例:
Salesforce
アクション Workbotコマンドの2番目の部分。 Workbotコマンドがアクションデータに対して行う処理。例:
showcreateupdate
アクションデータ Workbotコマンドの3番目の部分。 Workbotコマンドが操作するレコード。例:
invoicecustomerticket
コマンド入力フィールド レシピアクションを正常に実行するためにユーザーに要求する入力。特定の形式で定義します。 パラメータには、ファイルコンテンツ(例:テキスト、バイナリコンテンツ)を入力として受け入れるfile型を指定できます。 これはSlackにアップロードできます。 後続の操作で、WorkbotアクションDownload Attachmentを使用してこのファイルを使用できます。
コマンドヒント コマンドの機能の短い説明。 WorkbotアプリページのCommandsの下に表示されます。
非表示コマンドyesの場合、ユーザーがアプリ名を入力しても、コマンドはSlackチャネルにボタンとして表示されません。 noの場合、ユーザーがアプリ名を入力すると、コマンドはSlackチャネルにボタンとして表示されます。

Workbotコマンド形式

Workbotコマンドは、appactionaction dataの3つの要素を組み合わせて作成されます。

app action action-data

次の場合、アプリケーションはSalesforce、コマンドアクションはShow、ビジネスデータはAccountです。 Workbotは次のコマンドに応答します。

Salesforce show account

Workbotコマンド入力パラメータ形式

command input fieldsフィールドでは、レシピアクションを正常に実行するためにユーザーから必要なデータを決定できます。

各入力パラメータは、次の形式で指定する必要があります。

param_name optional:true prompt:false type:string hint:hint_to_help_users sample:example_data
コマンド入力フィールド説明
名前必須。 1語である必要があります。
任意 必須ではありません。 定義しない場合、デフォルトはoptional:trueです。 入力パラメータは任意になります。
プロンプト 必須ではありません。 定義しない場合、デフォルトはprompt:falseです。 プロンプトは生成されません。
データ型 必須ではありません。 定義しない場合、デフォルトはtype:stringです。 指定可能な型はstringbooleannumberfiledate_timeです。
ヒント 必須ではありません。 定義しない場合、デフォルトでヒントなしになります。
必須ではありません。 定義しない場合、デフォルトでサンプルデータなしになります。

この場合、Salesforceアカウントデータを正常に取得するには、Slackユーザーから完全なアカウント名を取得する必要があります。

name optional: false prompt: false type: string hint: Exact account name sample: IBM

設定済みのコマンド入力フィールドは、Workbotコマンドの後にユーザーへのフォローアップ質問として表示されます。

Salesforce show account入力パラメータSlackに表示されたコマンド入力フィールド

New commandトリガー出力データピル

New commandトリガーは、コマンドを実行したユーザー、コマンドが実行されたチャネルなど、コマンドに関するデータを保持する一連のデータピル変数も提供します。 次の表では、これらのデータピル変数について詳しく説明します。

New commandトリガー出力データツリー新しいボットコマンド出力データツリー

次の表に、トリガーからの出力データピルと、各フィールドに含まれるデータを示します。

New commandトリガーデータピル変数説明
アプリ Workbotコマンドの1番目の部分。 Workbotコマンドが操作するアプリ。例:
Salesforce
アクションデータ Workbotコマンドの2番目の部分。 Workbotコマンドがアクションデータに対して行う処理。例:
showcreateupdate
アクション Workbotコマンドの3番目の部分。 Workbotコマンドが操作するレコード。例:
invoicecustomerticket
メッセージID Workbotコマンドが送信されたエポック時間。 このWorkbotコマンドメッセージの下にスレッドを作成するために、Thread ID入力フィールドへの入力に使用できます。
以前に投稿されたメッセージを上書きするために、Message to updateでも使用できます。
コンテキスト このWorkbotコマンドに関するSlackデータ。例:投稿先のチームとチャネル、投稿したユーザー、該当する場合は所属していたスレッドのID。
コマンド入力パラメータ Workbotコマンドに対するフォローアップ質問によってユーザーから取得したデータ。

次の表には、Contextオブジェクトと、それに対応して保持されるデータに関する追加情報が含まれています。

Contextデータピル変数説明
チームSlackチームID
ユーザーSlackユーザーID
返信チャネル メッセージが投稿されたSlackチャネルID
ユーザーハンドルSlackユーザーハンドル
ユーザーのメールアドレスSlackユーザーのメール
ユーザー名Slackユーザーのフレンドリー名
スレッドID メッセージがスレッドに投稿された場合はThread ID、それ以外の場合はnull

次の表には、Modalsオブジェクトと、それに対応して保持されるデータに関する追加情報が含まれています。

モーダルデータピル説明
View IDコマンドが呼び出されたビューのView ID、別名 アクティブビュー。 コマンドがビュー送信から呼び出された場合、このView IDはビューの更新/プッシュには使用できません。送信時にビューがすでに閉じているためです。 アクティブなビューが1つだけの場合、このView IDはルートビューIDと同じになります。
Root View IDルートビューのView ID。
Previous View ID現在のビューの下にあるビューのView ID
Private metadata必要に応じて下流のレシピに渡すために使用できるプライベートデータ。 このフィールドは暗号化され、ユーザーには表示されません。
Hashモーダルの更新時に必要に応じて使用できる一意の値。 指定するとハッシュが検証され、最新のビューのみが更新されます。これにより、更新が非同期に行われる場合に正しいビューが更新されることが保証されます。

トリガーの出力にはMessage IDが含まれる場合があります。 Message IDに値が入るのは、New commandがボタンアクションによってトリガーされた場合のみです。 手動で入力したコマンドの結果としてコマンドがトリガーされた場合、このフィールドは空になります。

例:Salesforce show accountコマンド

次のGIFでは、DMを通じてWorkbotと直接チャットしています。 アプリ名"Salesforce"を入力すると、Workbotは使用可能なコマンドの一覧を生成し、ボタンとして表示します。 DMにSalesforce show accountとしてコマンドを手動で入力することもできます。

Salesforce show accountコマンドSalesforce show accountコマンド

ボタンをクリックするかコマンドを入力してSalesforce show accountコマンドが呼び出されると、Workbot for SlackのNew commandトリガーを含む対応するレシピがジョブを開始します。 このレシピには、Salesforce show accountコマンドを具体的にリッスンするWorkbot New commandトリガーがあります。 使用方法のインスピレーションとガイダンスとして、この機能を備えたビルド済みWorkbot for Slackレシピを参照してください。

Salesforce show accountコマンドレシピSalesforce show accountコマンドレシピサンプルレシピ

Salesforce show accountコマンドのトリガー設定は次のとおりです。

Salesforce show accountコマンドトリガー設定1Salesforce show accountコマンドトリガー設定

Workbotコマンドは、appactionaction dataの3つの要素を組み合わせて作成されることがわかっています。 この場合、アプリケーションは"Salesforce"、コマンドアクションはShow、ビジネスデータはAccountです。 Workbotは次のコマンドに応答します:Salesforce show account

command input parametersフィールドでは、レシピアクションを正常に実行するためにユーザーから必要なデータを決定できます。 この場合、Salesforceアカウントデータを正常に取得するには、Slackユーザーから完全なアカウント名を取得する必要があるため、パラメータを次のように定義します。

Salesforce show accountコマンドトリガー設定2Salesforce show accountコマンド入力フィールド設定

設定済みのコマンド入力パラメータは、Workbotコマンドの後にユーザーへのフォローアップ質問として表示されます。

Salesforce show account入力パラメータSlackでの入力パラメータ表示

ユーザーが必要な入力をすべて提供し終えると、レシピアクションが実行されます。 この場合、レシピアクションはSalesforceアカウントの詳細をグリッド形式のメッセージ添付ファイルとして表示することでした。

Salesforce show accountコマンド結果Salesforce show accountコマンド結果

New help messageトリガー

New help messageトリガーは、ダイレクトメッセージ(DM)またはチャネル(ユーザーによるメンション時、例:\@workbot help)を通じてhelpメッセージがボットに送信されたときに実行されます。 Workbotのデフォルトヘルプメッセージを使用するのではなく、ボットのhelpメッセージ応答を完全にカスタマイズする場合は、このトリガーを使用します。

このトリガーを使用できるユーザー

Enterprise Workbotを使用している場合は、New help messageトリガーを使用できます。 組み込みWorkbotを使用している場合、このトリガーは使用できません。

ユーザーがhelpコマンドを使用したときに新しいhelpメッセージが表示されるように、このトリガーをPost command replyと一緒に使用することをお勧めします。

各ボットで一度にアクティブにできるNew help messageトリガーレシピは1つだけです。

WARNING

このトリガーは、デフォルトのhelpメッセージとボットコネクション内のカスタムヘルプJSONの両方を上書きします。

New help messageトリガーを使用する理由

ボット固有の機能に基づいて、ボットのヘルプメッセージをカスタマイズすることを強くお勧めします。 これは、New help messageイベントにPost command replyで応答することで実行できます。 トリガーに含まれるコンテキストは、次の用途に使用できます。

  • User IDを使用してユーザー向けにメッセージをパーソナライズする
  • Is bot admin?を使用して、ユーザーがボット管理者かエンドユーザーかに応じて異なるhelpメッセージを表示する
  • ユーザーがhelpコマンドと一緒に送信するテキスト(例:help Salesforce)を使用して、代替のhelpメッセージを提供する
  • ボットコマンド、個人用コネクション、ボットレシピとジョブへのリンクを表示する

カスタマイズされたヘルプメッセージをPost command replyアクション内で定義すると、次のことができます。

  • ボット固有の機能をより詳しく説明する
  • ユーザーにスコープ設定できる他のアプリ(例:Salesforce、ServiceNow、Jira)からの情報を含める
  • モーダルを開いたり、ユーザーをボットアプリホームに移動させたりできる複数ステップのhelpフローを構築する

入力

入力は不要です。

出力

フィールド説明
ヘルプメッセージテキスト`help`の後に続く、ユーザーが指定したテキスト。"@workbot help me with salesforce" ==> "me with salesforce"
メッセージIDヘルプメッセージのMessage ID1490915654.038365
個人用コネクションコマンドユーザーの個人用コネクションを表示するために使用できるコマンド。 ボタンやその他のインタラクティブコンポーネントで呼び出すコマンドを定義するときに使用します。 connections
ボット情報コマンドuname
ボット管理者かどうか呼び出しユーザーがボット管理者の場合はtrue、それ以外の場合はfalse。true
ボットコマンド
(配列)
レシピIDボットコマンドレシピのレシピID。42
レシピ名ボットコマンドレシピの名前。Salesforce商談を作成
コマンド完全なコマンド名salesforce create opportunity
説明コマンドヒントsalesforce商談を作成します
レシピURLレシピのURL。https://app.workato.com/recipes/42
レシピジョブURLレシピジョブページのURL。https://app.workato.com/recipes/42#jobs
コンテキストチーム情報、ユーザー情報、メッセージまたはモーダル/アプリホームビュー情報などのSlack関連情報。Contextデータピル変数の表を参照してください

ヘルプメッセージの優先順位

ヘルプメッセージは次の優先順位を使用します。

  1. レシピ内のカスタムヘルプ
  2. コネクションレベルのカスタムヘルプJSON
  3. デフォルトヘルプ

新規イベントトリガー

New eventトリガーは、Slackワークスペースで指定したイベントが発生したときに実行されます。 このトリガーは、SlackのEvents APIおよびインタラクティブコンポーネント(ブロックアクションやモーダル送信など)と連携します。 各トリガーは1種類のイベントをサブスクライブします。

EVENTS APIトリガー

トリガー元として使用する予定のEvents API内のイベントには、Slackでボットがサブスクライブされている必要があります。

New eventトリガーWorkbot for SlackのNew eventトリガー

デフォルトでは、このトリガーには最も頻繁にサブスクライブされるイベントの一覧が含まれています。 探しているイベントが一覧にない場合は、Enter custom valueに切り替えてイベントを手動で設定できます。

カスタムイベントEvent nameはイベントをレシピに関連付け、コンテキストの提供に役立ちます。それ以外の場合、構文は強制されません

Event schemaの下にあるUse a sample JSONをクリックしてサンプルJSONを指定することで、イベントペイロードを生成することもできます。

イベントサンプルJSONサンプルJSONイベント

カスタムイベントJSONカスタムJSONイベント

サブスクライブできるイベントの一覧については、SlackのAPI Event Typesドキュメントを参照してください。

このトリガーはEnterprise botsと一緒に使用するのが最適です。これにより、ボットがサブスクライブするボットまたはワークスペースイベントを指定できます。 イベントをサブスクライブするには、Slackのボットに移動し、Event Subscriptionsに移動します。 必要なイベントをサブスクライブし、Save Changesをクリックします。

イベントサブスクリプションSlackのEvent Subscriptions

New shortcutトリガー

New shortcutトリガーは、ワークフローを開始する強力な方法です。 グローバルショートカットからワークフローを起動するか、メッセージショートカットを使用してSlackメッセージをタスクやチケットに変換します。 このトリガーはGlobalショートカットとMessageショートカットの両方で機能し、Enterpriseボットでショートカットを作成する必要があります。

ショートカットの例Workbotショートカットの例

動画をご希望ですか

Workbotショートカットのアクションを見る

トリガーされると、ショートカットはダイアログを起動してユーザーからコマンド入力フィールドを収集します。 メッセージの元の内容(ダイアログから取得した入力とともに)を使用して、タスク、チケットなどを作成できます。 ショートカットの使用を開始するには、ショートカットドキュメントを確認してください。

必要に応じて、ユーザーから追加情報を収集するダイアログボックスを起動します。

ショートカットトリガーNew shortcutトリガー

ショートカットの使用を開始するには、Shortcutsドキュメントを確認してください。

New URL mention

このトリガーはSlack内の特定の種類のURLを監視し、そのようなURLがメンションされると、事前定義済みのフォーマット済みデータをチャネルに取り込みます。 現在、SalesforceおよびGitHubのURLがサポートされています。

SlackでURLを送信すると、Workbotがチャネル内の全員に表示される特定の情報を提供できます。 たとえば、SalesforceリードURLを営業チャネルに送信すると、Workbotはその特定のリードに関する詳細情報を示すメッセージを自動的に送信します。

workbotトリガーWorkbot URL mention

トリガーでアプリケーション(現在はSalesforceとGitHubのみ)を選択し、Documentを選択して、必要に応じてアクションを設定します。 デフォルトでは、Workbotが参加しているチャネルにSalesforceまたはGitHubのURLを提供すると、Workbotからのプロンプトがトリガーされます。 このプロンプトでは、送信したURLのコンテンツの詳細を表示するかどうかを確認します。 yesを選択してレシピをトリガーします。 メッセージに含めるフィールドを増減する場合は、Workatoでレシピを編集することもできます。

workbotトリガーWorkbot URL詳細

New dynamic menu event

ダイアログを呼び出すWorkbotコマンドレシピでは、動的メニューオプションを使用してselectフィールドを定義できます。

動的メニュー動的メニューオプションを含むWorkbotコマンドレシピ

このトリガーは、ユーザーがそのようなフィールドに入力したときに実行され、ユーザーが入力した内容(例:typeahead値)を返します。 イベントをトリガーするには、少なくとも5文字を入力する必要があります。

このtypeahead値を使用して、レコードの一覧(Salesforceなどの別のアプリから)を取得し、メインレシピ(例:selectフィールドがあるダイアログを投稿するレシピ)に返します。

Typeaheadの例Typeheadの例

Return menu optionsアクションを使用して、レコードの一覧を動的メニューに返すことができます。 したがって、このトリガーは常にReturn menu optionsアクションと組み合わせる必要があります。

入力

動的メニュー名

このメニューの識別子。

コマンド入力フィールド

動的メニューオプションを含むWorkbotコマンドレシピは、Dynamic menu recipe paramsフィールドを通じてDynamic menuレシピにパラメータを渡すことができます。 動的メニューレシピは、メニューオプションの生成時にこれらの追加パラメータを使用できます。

動的メニューレシピパラメータ値'Closed Won'を持つ'stagename'パラメータを渡す、動的メニューオプションフィールドを含むWorkbotコマンドレシピ

これに対応して、トリガーにも同じパラメータを定義する必要があります。

動的メニュートリガー内のパラメータ同じ'stagename'パラメータが定義された対応する動的メニューレシピ

その後、動的メニューレシピはメニューオプションの生成時に追加パラメータを利用できます。 以下の例では、パラメータstagenameが動的メニューレシピに渡され、SOQL検索をさらに絞り込むことができます。

動的メニューパラメータの例SOQL検索を絞り込むために'stagename'パラメータが渡される

出力

フィールド説明
イベントコンテキストチームコマンドが呼び出されたチームIDとドメイン。
ユーザーコマンドを呼び出したユーザーのユーザーIDと名前
チャネル コマンドが呼び出されたチャネルIDと名前。
状態 動的メニューレシピIDとパラメータの名前と値のペアを含むシステムメッセージ。
アクションts アクションが呼び出された時刻のタイムスタンプ。
Typeahead名前動的メニューイベントの受信元パラメータの名前。
動的メニューオプションフィールドにユーザーが入力した文字。
Callback IDシステムメッセージ
パラメーター 動的メニューオプションを含むWorkbotコマンドレシピによって渡された名前と値のペア。

FAQ

Workbot for Slackとは何ですか。また、その主な機能は何ですか。

Workbot for Slackは、Slack内のWorkbotにコマンドを送信できるツールです。 その後、Workbotは接続済みアプリと連携して、次のようなさまざまなタスクを実行します。

  • 顧客アカウントの詳細を取得
  • 商談をクローズ
  • チケットを作成および更新
Workbotコマンドはどのように処理されますか。また、Workatoレシピはどのような役割を果たしますか。

各Workbotコマンドは、Workatoレシピを使用して処理されます。 レシピのトリガーはWorkbotコマンドをイベントとして取得し、レシピがコマンドに応答して実行するアクションを決定します。 これにより、Slackコマンドを通じて実行されるカスタムワークフローを作成できます。

Workbot for Slackコネクタで使用できるトリガーは何ですか。

Workbot for Slackコネクタには5つのトリガーがあります。

  • New command
  • New help message
  • New event(リアルタイム)
  • New shortcutトリガー
  • New URL mention

これらのトリガーにより、Slack内でさまざまなやり取りと自動化ワークフローが可能になります。

New commandトリガーはどのように機能し、どの入力フィールドを設定できますか。

New commandトリガーは、カスタムWorkbotコマンドの設定に使用されます。 指定されたコマンドをSlackで監視し、コマンドが呼び出されるとレシピアクションを実行します。 次のような入力フィールドを設定できます。

  • アプリ
  • アクション
  • アクションデータ
  • コマンド入力フィールド
  • コマンドヒント
Workbotコマンドを作成する形式は何ですか。また、入力パラメータはどのように定義されますか。

Workbotコマンドは、3つの要素を組み合わせて作成されます。

  • アプリ
  • アクション
  • アクションデータ

コマンドの入力パラメータは、次のようなフィールドを含む特定の形式を使用して定義されます。

  • 名前
  • プロンプト
  • データ型
  • ヒント
New commandトリガーから利用できる出力データピルは何ですか。また、どのような情報を提供しますか。

New commandトリガーは、コマンドに関する情報を含む出力データピルを生成します。例:

  • アプリ
  • アクションデータ
  • アクション
  • メッセージID
  • コンテキスト

New command用に作成された出力データピルは、後続のレシピアクションで使用できます。

New help messageトリガーを使用して、Slack内のWorkbotのヘルプメッセージをカスタマイズするにはどうすればよいですか。

New help messageトリガーを使用すると、ユーザーがヘルプをリクエストしたときのWorkbotのヘルプメッセージ応答を完全にカスタマイズできます。 実行できる操作:

  • メッセージをパーソナライズ
  • ユーザーロールに基づいて異なるヘルプメッセージを表示
  • 代替ヘルプメッセージを提供
New eventトリガーを使用してどのイベントをサブスクライブできますか。また、SlackのEvents APIと連携できますか。

New eventトリガーは、Slackワークスペースで指定されたイベントが発生したときに実行されます。 ユーザーはさまざまなイベントをサブスクライブし、特定のイベントに対するトリガーの応答方法を設定できます。 このトリガーはSlackのEvents APIと連携し、イベントのカスタマイズを可能にします。

New shortcutトリガーはどのように機能し、どのような用途がありますか。

New shortcutトリガーを使用すると、グローバルショートカットからワークフローを起動したり、メッセージショートカットを使用してSlackメッセージをタスクやチケットに変換したりできます。 ユーザーから入力フィールドを収集し、そのユーザー入力に基づいてタスクやチケットを作成します。

New URL mentionトリガーの目的は何ですか。また、どの種類のURLがサポートされていますか。

New URL mentionトリガーは、Slack内の特定の種類のURLを監視し、それらのURLがメンションされたときに事前定義済みのフォーマット済みデータを取得します。 現在、このトリガーはSalesforceおよびGitHubのURLをサポートしており、メンションされたURLに基づいて追加情報を表示するために使用できます。

New dynamic menu eventトリガーはどのように機能し、どのような用途がありますか。

New dynamic menu eventトリガーは、動的メニューオプションを含むWorkbotコマンドレシピで使用されます。 このトリガーは、ユーザーが動的メニューフィールドに情報を入力したときに実行され、そのユーザー入力を返します。 このトリガーは、検索結果を絞り込んだり、ユーザー入力に基づいてアクションを実行したりするためによく使用されます。

Last updated: