ガイド

担当業務のトリガー

ほかの場所で何かが起きたときに担当業務を始めます。トリガーのアドレスにイベントが届き、署名で本当の送信元だけを通し、必要なイベントだけに絞り込んで、ボットが受け取るメッセージの形に整えます。

4 分で読めます

トリガーを追加するこのセクションへのリンクをコピー

  1. 担当業務を開き、対象の担当業務を探します。カードの「トリガー」の欄で「トリガーを追加」を押します。
  2. 「トリガー」で種類を選びます。Webhook を送れるサービスなら「Webhook」、ほかに「GitHub」「Linear」「Sentry」「PagerDuty」「メール」「Slack」があります。
  3. 下のフィルターを設定して保存します。HTTP のトリガーには、送信先のアドレスが「POST 先」に表示され、「URL をコピー」でコピーできます。

トリガーは、それが始める担当業務の持ち主のものです。見たり変えたりできるのは自分のトリガーだけです。一時停止中または完了済みの担当業務のトリガーは、イベントを受け付けても実行を始めません。

配信の署名このセクションへのリンクをコピー

アドレスを知っているだけでは何も通りません。すべての配信は送信元からのものであることを証明する必要があります。「Webhook」と「GitHub」のトリガーには作成時に専用のキーが作られ、「キーを表示」「キーをコピー」「ヘッダーをコピー」で送信元に渡せます。ほかの種類では、送信するサービスに表示される署名シークレットを貼り付けます。それまではトリガーに「署名シークレットを待っています」と表示され、配信を拒否します。

Webhook トリガーの送信元では Webhook を送るサービスを選び、そのサービスの署名方式・イベント名の項目・配信 ID を使います。任意の送信元(このデプロイのキーで署名)は、Bearer のキーか、タイムスタンプ付きの署名を受け付けます。署名のタイムスタンプが現在時刻から離れすぎている配信はリプレイとして拒否します。その幅はタイムスタンプ許容範囲(秒)で 30〜3600 秒の間で決められ、既定は 300 秒です。

「キーをローテーション」で新しいキーを作ります。古いキーを使える期間では、送信元を更新する間、古いキーを最長 1 週間使えるようにできます。古いキーの受け付けを止めるで早めに終えられます。キーの更新は監査ログに記録されます。

ヒント

送信元の制限の受け付けるアドレスで、Webhook トリガーへの配信を指定したアドレスや範囲からだけに制限でき、イベントの最大サイズ(KB)でそれより大きいものを拒否できます。どちらも署名より先に確認します。

フィルターの条件このセクションへのリンクをコピー

トリガーごとにフィルターが 1 つあり、次の順に確認します。

  • 「イベントの種類」:カンマ区切りの一覧です。空欄ならすべてのイベントが対象です。各項目はその下位の種類にも一致するため、issues は issues.opened にも一致します。
  • 「この項目が次の場合のみ」…「次と等しい」:イベントの 1 つの項目が特定の値であることを求めます。大文字と小文字は区別しません。
  • 条件(CEL・任意):event.type と event.payload を使った、true になるべきルールで、トリガーを追加するときに設定します。イベントにない項目は一致しないものとして扱います。

直近のイベントで試すは、保存されているいちばん新しいイベントで条件を確かめ、実行が始まるかどうかを表示します。何も変更しません。1時間あたりの最大実行数で、トリガーが実行を始める回数に上限を設けられます。上限を超えた配信は受け付けたうえで破棄されます。同じイベントが再配信されても、2 回は実行しません。

項目のマッピングこのセクションへのリンクをコピー

プロンプトテンプレートがない場合、ボットはイベント全体を受け取ります。ある場合は、あなたが書いたメッセージだけを受け取り、{{issue.title}} のようなプレースホルダーにはイベントの項目が入ります。直近の実イベントの項目には、署名を確認できたいちばん新しい配信の項目が並び、ワンクリックで挿入できます。プレビューで、ボットが受け取るとおりのメッセージを確認できます。

このトリガー専用の指示(任意)は、このトリガーが動くたびに担当業務の指示の後に追加されるため、1 つの担当業務の 2 つのトリガーに別々のことを頼めます。Webhook トリガーにはペイロードのスキーマも設定でき、満たさない配信は何かが実行される前に拒否されます。

注意

イベントで届いた内容は、常に信頼できない内容としてボットに渡されます。そのため、ペイロードの文章でボットに新しい指示を与えることはできません。

テストと受信の記録このセクションへのリンクをコピー

テスト送信は、サンプルのイベント、または貼り付けたテスト用ペイロード(JSON、任意)を、署名キーなしで届けます。実際に実行が始まります。ボットにはテスト用データであることが伝えられますが、いつものツールを使える状態です。

最近の受信には、トリガーへの直近 20 件の配信について、署名を確認できたか、送信元に返した応答、どうなったか(フィルターに一致しませんでしたや重複のため再実行なしなど)、開始された実行へのリンクが表示されます。認証情報を含むヘッダーの値は隠されます。

イベントの再実行このセクションへのリンクをコピー

「実行を表示」の再実行で、ある実行のイベントをもう一度届け、新しい実行として始めます。指示を直したあとなどに使います。元の実行はそのまま残り、新しい実行には再実行の印と元の実行を見るのリンクが付きます。再実行は担当業務ごとに 1 時間に 10 件まで、担当業務が有効な間だけでき、すべて監査ログに記録されます。

イベントではなく予定で仕事を始めるには、ルーティンと担当業務を参照してください。

最終更新日