• 製品
  • 使用を開始する
  • 関連ドキュメント
  • リソース

Webhook と統合する

この記事では、Jira Service Management Cloud の一部のお客様に段階的に展開されている、Jira Service Management でネイティブに利用できる新しいアラート機能を取り上げています。ご利用のサイトにはまだ表示されていないか、利用できない可能性があります。

Webhook のロゴ

URL エンドポイントには、Web から URL にアクセスできる限り、任意のプラットフォーム、Web サーバーなどを指定できます。Webhook データには、アラート アクティビティ (作成、承認など) とアラート フィールドのサブセット (アラート ID、ユーザー名、エイリアス、エンティティ、ユーザー ID) が、HTTP リクエスト ペイロード (JSON) の一部として含まれます。カスタム ヘッダーを定義して Webhook 呼び出しを追加することもできます。関連するチェックボックスをオンにするだけで、アラートの説明と詳細を送信できます。

Webhook 統合によって送信されるアラート アクション データでは、[Description (説明)] フィールドと [Details (詳細)] フィールドは 1000 文字に切り捨てられます。

Webhook の統合を追加する

双方向統合は Free プランと Standard プランではサポートされていません。他のすべての統合は FreeStandard でチーム レベルでサポートされています。ただし、送信統合を機能させるには、上位のプランにアップグレードする必要があります。Settings (歯車アイコン) > Products (Jira 設定の下) > OPERATIONS からサイト レベルで統合を追加できるのは、Premium プランと Enterprise プランのみです。

統合をチームの運用ページから追加すると、そのチームが統合の所有者になります。つまり、Jira Service Management は、この統合を通じて受信したアラートをチームにのみ割り当てます。

Webhook は送信統合であるため、使用できるのは Premium プランと Enterprise プランのみです。Jira Service Management で Webhook 統合を追加するには、次の手順を実行します。

  1. チームの運用ページに移動します。

  2. 左側のナビゲーション パネルで、[統合]、[統合を追加] の順に選択します。

  3. 検索を実行して「Webhook」を選択します。

  4. 次の画面で、統合の名前を入力します。

  5. オプション: 特定のチームが統合からのアラートを受信するようにする場合は、[Assignee team (担当者チーム)] のチームを選択します。

  6. [続行] を選択します。
    この時点で、統合が保存されます。

  7. 統合設定ページの [Edit (編集)] に移動します。
    [Edit integration settings (統合設定を編集)] ダイアログが開きます。

    1. [Authenticate with a Webhook account (Webhook アカウントで認証)] を選択します。

    2. Webhook URL を [Webhook URL] に貼り付けます。

    3. Webhook 呼び出し用に追加の HTTP ヘッダーを設定します。

    4. 必要に応じて、[Add alert description to payload (ペイロードにアラートの説明を追加)] と [Add alert details to payload (ペイロードにアラートの詳細を追加)] を選択します。

    5. [保存] を選択します。

  8. [統合をオンにする] を選択します。
    統合のために作成したルールは、統合をオンにした場合にのみ機能します。

[Add alert description to payload (ペイロードにアラートの説明を追加)] と [Add alert details to payload (ペイロードにアラートの詳細を追加)] の各オプションは作成アクションとカスタム アラート アクションでのみ使用できます。

アラート アクションをマッピングする

Jira Service Management ではアラート アクション用の Webhook URL を POST できます。[Post to Webhook URL for Jira Service Management alerts (Jira Service Management アラート用の Webhook URL に POST)] セクションを使用してアラート アクションを特定の URL に POST します。たとえば、「アラートが作成されたときに URL に POST する」を追加します。これを行うには、「Jira Service Management でアラートが作成された場合」に「URL に POST する」のマッピングを定義します。

  • 「アラートにタグが追加される」アクションと「アラートでカスタム アクションが実行される」アクションは、他のアクションと異なります。これらのアクションのいずれかを選択すると、このマッピングが機能するタグまたはカスタム アクションを入力するための追加のフィールドが表示されます。

  • タグをカンマで区切って、複数のタグを入力します。複数のタグを入力した場合、マッピングは、指定されたタグが 1 つ以上アラートにある場合に機能します。タグのフィールドを空のままにすると、どのタグでもマッピングが機能します。

  • 1 つの Jira Service Management アクションが Webhook の統合で複数の「URL に POST する」アクションに関連付けられている場合、「アラートにタグが追加される」アクションと「アラートでカスタム アクションが実行される」アクションを除いて、エラーが発生します。マッピングは特定のタグとカスタム アクション名によって異なるため、これらのアクションに対してのみ複数のマッピングを保存できます。

さまざまなアクションの Webhook データの例については、「Jira Edge Connector アラート アクション データ」を参照してください。

 

さらにヘルプが必要ですか?

アトラシアン コミュニティをご利用ください。