第27章 通知
メール、Slack、Webhook などの 通知タイプ は、通知テンプレートのインスタンスであり、通知テンプレートで定義された名前、説明、設定を持ちます。
以下に、通知テンプレートの追加に必要な詳細の例を示します。
- メールの通知テンプレートには、ユーザー名、パスワード、サーバー、および受信者が必要です。
- Slack 通知テンプレートには、トークンとチャンネルのリストが必要です。
- Webhook 通知テンプレートには、URL とヘッダーが必要です。
ジョブが失敗すると、通知テンプレートで定義した設定を使用して通知が送信されます。
以下に、通知システムの一般的なフローを示します。
-
API または UI を介して、
/api/v2/notification_templates エンドポイントでREST APIへの通知テンプレートを作成します。 -
通知テンプレートは、サポートするさまざまなオブジェクト (ジョブテンプレートのすべてのバリアント、組織およびプロジェクト) のいずれかに対して、通知が必要な適切なトリガーレベル (開始、成功、またはエラー) に割り当てます。たとえば、ジョブテンプレート 1 が失敗したときにトリガーするように、特定の通知テンプレートを割り当てることができます。この場合、通知テンプレートを
/api/v2/job_templates/n/notification_templates_errorAPI エンドポイントにあるジョブテンプレートに関連付けます。 - ジョブの開始時と終了時の通知を設定できます。ユーザーとチームは、任意のジョブに割り当てることができる独自の通知を定義することもできます。
27.1. 通知の階層
通知テンプレートは、次のような親オブジェクトで定義されたテンプレートを継承します。
- ジョブテンプレートは、ジョブテンプレート用に定義された通知テンプレートを使用します。さらに、ジョブテンプレートで使用されるプロジェクトや、ジョブテンプレートがリストされている組織から通知テンプレートを継承できます。
- プロジェクト更新は、プロジェクトで定義される通知テンプレートを使用し、それに関連付けられる組織から通知テンプレートを継承します。
- インベントリー更新は、その下にリスト表示される組織で定義される通知テンプレートを使用します。
- ad hoc コマンドは、インベントリーが関連付けられる組織に定義された通知テンプレートを使用します。
