メインコンテンツまでスキップ

通知設定

このセクションでは、Apidog でサードパーティ統合を設定する方法を学びます。

サードパーティ統合​

外部通知​

External Notificationsを使用すると、通知をサードパーティアプリケーションと統合できます。通知要件に基づいて、通知イベントを設定することができます。現在、サポートされている通知チャネルには Slack、Webhook、Jenkins があります。

使用シナリオ​

通知をサードパーティアプリケーションと統合すると、プロジェクトメンバーが対応する通知イベントをトリガーしたときに、通知がリアルタイムでサードパーティアプリケーションプラットフォームに送信されます。

設定手順​

プロジェクトマネージャーのみが設定できます。サードパーティアプリケーションプラットフォームごとにサポートされている通知イベントは異なるため、サードパーティアプリケーションごとの通知イベントの設定項目も異なります。

Slack​

Apidog は、Slack アプリIncoming WebHooksを統合し、特定のChannelに通知イベントを送信することをサポートしています。指定された Channel に Incoming WebHooks の Webhook URL を設定することで、イベントメッセージを Slack の Channel に送信できます。

設定フィールドの説明:

設定フィールド必須説明
通知名Noサードパーティ統合通知に名前を付け、その目的を記録します。
トリガーイベントYesサポートされているイベント：API 変更、データモデル変更、ドキュメント変更、データのインポート、自動テスト
サービス URLYes「Incoming WebHooks - 統合設定」内の Webhook URL

Slack の特定チャンネルにバインド

プロジェクト管理者は、サードパーティ統合機能を使用して、Slack アプリに追加された Incoming WebHooksを Apidog のプロジェクト通知イベントと関連付け、API 変更、ドキュメント変更、テスト完了などの関連情報を Slack の指定されたチャンネルにプッシュすることができます。

  1. 特定のチャンネルのIntegrations - Appsで、Incoming WebHookをインストールして追加します。

apidog apidog

  1. インストールが完了したら、Incoming WebHooksの右側にある View ボタンをクリックします。 apidog

  2. これによりIncoming WebHooksの説明ページが開きますので、Configuration をクリックしてセットアップします。 apidog

  3. Slack に Add to Slackをクリックします。 apidog

  4. Apidog の通知イベントメッセージをプッシュするチャンネルを選択し、Add Incoming WebHooks integrationをクリックします。 apidog

  5. Webhook URL を取得してコピーします。 apidog

  1. 新しい通知イベントを作成

    "設定" > "通知設定" > "通知対象" > "新規"をクリックして、新しい通知イベントを作成します。

    1. 通知名を入力します。
    2. チャンネルとしてSlackを選択します。
    3. Incoming WebHooks 設定から取得した Webhook URL をサービス URLに貼り付けます。

apidog

保存をクリックすると、バインドが完了します。選択したイベントがトリガーされると、対応する Slack チャンネルで通知が受信されます: apidog

Webhook​

通知イベントを HTTP サーバーに送信することができます。POST リクエストを受信する URL アドレスを指定することで、イベントメッセージを HTTP サーバーに送信できます。

設定フィールドの説明:

設定フィールド必須説明
通知名No通知の目的を記録するために、サードパーティ統合通知に名前を付けます。
トリガーイベントYesサポートされているイベント：API 変更、データモデル変更、ドキュメント変更、データのインポート、自動テスト
サービス URLYesリクエストを受信する HTTP サーバーの URL アドレス
署名認証No送信された内容は HMAC SHA1暗号化アルゴリズムで暗号化され、トークンをキー（KEY）として使用し、値は16進数で表示されます（トークンの設定が必要）。また、プレフィックスsha1=を含みます。

セルフホストされた HTTP サーバーのバインディング​

プロジェクト管理者は、サードパーティ統合機能を使用して、セルフホストされた HTTP サーバーを Apidog のプロジェクト通知イベントと関連付けることで、HTTP サーバーで API 変更、ドキュメント変更、オートメーションテスト完了の通知を受信できます。

新しい通知イベントの作成

"設定" > "通知設定" > "通知対象" > "新規" をクリックして、新しい通知イベントを作成します。

  1. 通知名を入力します。
  2. Webhookをチャンネルとして選択します。
  3. サービス URLフィールドにセルフホストされた HTTP サーバーの URL を貼り付けます。
  4. 署名認証が有効になっている場合、キーをコピーして署名キーフィールドに貼り付けます。

apidog

保存後、バインドが完了します。選択したイベントがトリガーされると、HTTP サーバーで通知が受信されます。

Jenkins​

通知イベントを Jenkins サービスに送信することができます。Jenkins Webhook URL を設定することで、イベントメッセージを Jenkins に送信できます。

設定フィールドの説明:

設定フィールド必須説明
通知名No通知の目的を記録するために、サードパーティ統合通知に名前を付けます。
トリガーイベントYesAPI 変更、データモデル変更、データのインポート、自動テスト上記のいずれかのイベントが発生すると、リアルタイム通知がトリガーされます。
サービス URLYesURL は Generic Webhook Trigger プラグインで設定されます。
署名認証NoAuthorization Bearer ヘッダーを介して Generic Webhook Triggerプラグインに送信されます。

Jenkins サービスのバインド​

プロジェクト管理者は、サードパーティ統合機能を使用して、Jenkins の Generic Webhook Triggerプラグインで設定された Webhook URL を Apidog のプロジェクト通知イベントと関連付け、API 変更、ドキュメント変更、オートメーションテスト完了などのイベントがトリガーされたときに、Jenkins でビルドアクションを自動的にトリガーし、ビルド履歴でメッセージを確認できます。

  1. Jenkins Generic Webhook Trigger プラグインで設定された Webhook URL

Jenkins ダッシュボードで新しいビューを作成します:

apidog

前の手順でビューをクリックして、Configure > Build Triggers に進み、Generic Webhook Trigger を選択します。Webhook URL は "http://" + "サービスアドレス" + "/generic-webhook-trigger/invoke" です。

apidog

カスタムトークンがサポートされています:

apidog

  1. 通知名を入力します

"設定" > "通知設定" > "通知対象" > "新規"をクリックして、新しい通知イベントを作成します:

  1. 通知名を入力します
  2. Jenkinsをチャンネルとして選択します
  3. サービス URL フィールドに、Generic Webhook Trigger プラグインで設定された Webhook URL を貼り付けます。
  4. カスタムトークンを使用している場合は、Tokenをコピーして 署名トークン フィールドに貼り付けます。

apidog

保存後、バインドが完了します。選択したイベントがトリガーされると、Jenkins が自動的にビルドアクションを開始し、ビルド履歴でメッセージを確認します:

apidog