Apidog Docs
通知設定
通知概要
Apidogは、特定のイベントが発生した際に指定された受信者に通知を送信するために、サードパーティのアプリケーションと統合することができます。特定のイベントがトリガーされると、Slackのようなプラットフォームにリアルタイムで通知が送信されます。現在サポートされている通知チャネルは以下の通りです：
- Slack
- Webhook
- Jenkins
通知設定を構成できるのはプロジェクト管理者のみです。現在、メール通知は以下のイベントにのみ利用可能です：
- 自動テスト完了/失敗
- 継続的インテグレーション完了/失敗
- スケジュールされたタスク完了/失敗
通知対象
通知対象は、特定のイベントが発生した際に特定のチャネルを通じてメッセージを受け取る受信者です。
通知を設定するには、まず通知対象を作成し、名前を指定し、チャネルを選択し、その設定を構成する必要があります。各チャネルには独自の設定プロセスがあります。以下のセクションでは、それらをステップバイステップで設定する方法を説明します。
Slack
Apidogは、Slackの特定のChannelに通知イベントを送信することをサポートしています。これは、指定されたChannelにIncoming WebHooksを統合し、Incoming WebHooksのWebhook URLを設定することで、イベントメッセージをSlackのChannelに送信できます。
設定フィールドの説明：
| 設定フィールド | 必須 | 説明 |
|---|---|---|
| 通知名 | いいえ | サードパーティ統合通知に名前を付け、その目的を記録します。 |
| トリガーイベント | はい | サポートされているイベント：APIの変更、スキーマの変更、ドキュメントの変更、データのインポート、自動化テスト |
| サービスURL | はい | 「Incoming WebHooks - 統合設定」のWebhook URL |
Apidog通知とSlackの統合
プロジェクト管理者は、サードパーティ統合機能を使用して、SlackのChannelに追加されたIncoming WebHooksをApidogのプロジェクト通知イベントと関連付け、指定されたSlackのChannelに関連するAPIの変更、ドキュメントの変更、テストの完了などをプッシュすることができます。
- SlackのChannelで、右上の「チャネル詳細を開く」オプションをクリックします。
特定のChannelの統合 - アプリで、Incoming WebHookをインストールして追加します。
<img style="background-color: transparent;" src="https://assets.apidog.com/uploads/help/2024/02/21/da4e1353dab1fd737235d40e3803ec5c.png" />
- インストールが完了したら、
Incoming WebHooksの右のボタンをクリックして表示します。
Incoming WebHooksの説明ページが開きますので、設定をクリックしてセットアップします。
Slackに追加をクリックします。
- Apidog通知イベントメッセージをプッシュするChannelを選択し、
Incoming WebHooks統合を追加をクリックします。
- Webhook URLを取得してコピーします。
- 新しい通知対象を作成
「設定」>「通知」>「通知対象」をクリックし、新しい通知対象を作成します。
- 通知対象名を入力します。
- 通知チャネルとして`Slack`を選択します。
- `サービスURL`にIncoming WebHooks設定から取得したWebhook URLを貼り付けます。
保存をクリックすると、設定が完了します。次に通知イベントを作成することができます。
通知イベントが設定され、トリガーされると、指定されたSlackのChannelでメッセージを受け取ることができます。
Webhook
通知イベントをHTTPサーバーに送信することをサポートしています。POSTリクエストを受信するURLアドレスを指定することで、HTTPサーバーにイベントメッセージを送信できます。
設定フィールドの説明：
| 設定フィールド | 必須 | 説明 |
|---|---|---|
| 通知名 | いいえ | サードパーティ統合通知に名前を付け、その目的を記録します。 |
| トリガーイベント | はい | サポートされているイベント：APIの変更、データモデルの変更、ドキュメントの変更、データのインポート、自動化テスト |
| サーバーURL | はい | リクエストを受信するHTTPサーバーのURLアドレス |
| 署名認証 | いいえ | 送信される内容は、HMAC SHA1暗号化アルゴリズムで暗号化され、トークンをKEYとして16進数で値を表示します（トークンの設定が必要です）。プレフィックスsha1=を含みます。 |
Apidog通知とセルフホストのHTTPサーバーの統合
プロジェクト管理者は、サードパーティ統合を使用して、セルフホストのHTTPサーバーをApidogのプロジェクト通知イベントと関連付け、HTTPサーバーで関連するAPIの変更、ドキュメントの変更、自動化テストの完了通知を受信することができます。
Apidog通知をセルフホストのHTTPサーバーと統合するには、「設定」>「通知」>「通知対象」をクリックし、新しい通知対象を作成します。
- 通知対象名を入力します。
- チャネルとして
Webhookを選択します。 サービスURLフィールドにセルフホストのHTTPサーバーのURLを貼り付けます。- 署名認証が有効な場合は、
署名キーフィールドにキーをコピーして貼り付けます。
保存をクリックすると、設定が完了します。次に通知イベントを作成することができます。
Jenkins
Jenkinsサービスに通知イベントを送信することをサポートしています。Jenkins Webhook URLを設定することで、イベントメッセージをJenkinsに送信できます。
設定フィールドの説明：
| 設定フィールド | 必須 | 説明 |
|---|---|---|
| 通知名 | いいえ | サードパーティ統合通知に名前を付け、その目的を記録します。 |
| トリガーイベント | はい | APIの変更、データモデルの変更、データのインポート、自動化テスト。上記のいずれかのイベントが発生するとリアルタイム通知がトリガーされます。 |
| サービスURL | はい | Generic Webhook Triggerプラグインで設定されたURL |
| 署名認証 | いいえ | Generic Webhook TriggerプラグインにAuthorization Bearerヘッダーを介して送信されます。 |
Apidog通知とJenkinsサービスの統合
プロジェクト管理者は、サードパーティ統合機能を使用して、JenkinsのGeneric Webhook Triggerプラグインで設定されたWebhook URLをApidogのプロジェクト通知イベントと関連付け、APIの変更、ドキュメントの変更、自動化テストの完了などのイベントがトリガーされた際にJenkinsでビルドアクションを自動的にトリガーし、ビルド履歴でメッセージを確認することができます。
- JenkinsのGeneric Webhook Triggerプラグインで設定されたWebhook URL
Jenkinsダッシュボードで新しいビューを作成します：
前のステップでビューをクリックして設定>ビルドトリガーに入り、Generic Webhook Triggerを選択します。Webhook URLは"http://"+"サービスアドレス"+"/generic-webhook-trigger/invoke"です。
カスタムトークンがサポートされています：
- 新しい通知対象を作成
「設定」>「通知」>「通知対象」をクリックし、新しい通知対象を作成します。
- 通知対象名を入力します。
- チャネルとして`Jenkins`を選択します。
- [Generic Webhook Trigger](https://plugins.jenkins.io/generic-webhook-trigger/)プラグインで設定されたWebhook URLを`サービスURL`フィールドに貼り付けます。
- カスタムトークンを使用する場合は、`署名トークン`フィールドに`トークン`をコピーして貼り付けます。
保存をクリックすると、設定が完了します。次に通知イベントを作成することができます。
通知イベントが設定され、トリガーされると、Jenkinsは自動的にビルドアクションを開始し、ビルド履歴でメッセージを確認することができます：
指定されたメールアドレスにメールで通知を送信できます。現在、メール通知は以下のイベントにのみ利用可能です：
- 自動テスト完了/失敗
- 継続的インテグレーション完了/失敗
- スケジュールされたタスク完了/失敗
設定フィールドの説明：
| フィールド | 必須 | 詳細 |
|---|---|---|
| 名前 | はい | 通知対象の目的や特徴を強調する説明的な名前。 |
| 通知メールアドレス | はい | 通知を受け取るメールアドレスを入力します。プロジェクトメンバーのメールアドレスを選択するか、手動でアドレスを入力できます。複数のメールアドレスがサポートされています。 |
Apidog通知とEmailの統合
1. 通知対象名を入力します。
2. チャネルとして`Email`を選択します。
3. メールアドレスを入力します。
保存をクリックすると、設定が完了します。次に通知イベントを作成することができます。
通知イベント
通知イベントを作成して、指定された受信者（通知対象）に通知をトリガーするイベントを指定できます。通知イベントを設定するには、以下を構成する必要があります：
- 通知イベント名
- トリガーイベント
- 通知対象
トリガーイベント
以下の通知イベントから選択して通知をトリガーできます：
| トリガーイベント | 詳細 |
|---|---|
| APIの変更 | API作成 API更新 API削除 |
| スキーマの変更 | スキーマ作成 スキーマ更新 スキーマ削除 |
| ドキュメントの変更 | ドキュメント作成 ドキュメント更新 ドキュメント削除 |
| データインポート | インポート（手動インポート） インポート（自動同期） |
| レスポンスコンポーネントの変更 | レスポンスコンポーネント作成 レスポンスコンポーネント更新 レスポンスコンポーネント削除 |
| スプリントブランチの変更 | スプリントブランチマージ スプリントブランチ作成 スプリントブランチアーカイブ スプリントブランチ削除 スプリントブランチ取得 |
| APIバージョンの変更 | APIバージョン作成 APIバージョン削除 |
| セキュリティスキームの変更 | セキュリティスキーム作成 セキュリティスキーム更新 セキュリティスキーム削除 |
:::tip[]
自動テストに関連する通知（例：自動テスト完了、継続的インテグレーション完了、スケジュールされたタスク完了）については、各テストシナリオごとに個別に設定を構成する必要があります。このアプローチはより柔軟で、実際のユースケースに適しています。
:::
通知対象
トリガーイベントが発生した際に通知を受け取る通知対象を選択します。プロジェクト内で既に設定されている通知対象から選択し、必要に応じて複数の対象を選択できます。
ただし、メール通知は以下の3つの特定のイベントにのみサポートされています：
- 自動テスト完了/失敗
- 継続的インテグレーション完了/失敗
- スケジュールされたタスク完了/失敗