Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. プロジェクト管理
  • Apidog ラーニングセンター
  • はじめに
    • Apidog の概要
    • Apidog の基本概念
    • Apidog のナビゲーション
    • クイックスタート
      • 概要
      • エンドポイントの作成
      • リクエストの作成
      • アサーションの追加
      • テストシナリオの作成
      • APIドキュメントの共有
      • さらに詳しく
    • Apidogへの移行
      • 概要
      • 手動インポート
      • スケジュールインポート（データソースのバインド）
      • インポートオプション
      • データのエクスポート
      • インポート元
        • Postman からのインポート
        • OpenAPI 仕様のインポート
        • cURL のインポート
        • Markdown のインポート
        • Insomnia からインポート
        • apiDoc からインポート
        • .har ファイルをインポート
        • WSDL のインポート
  • モックAPIデータ
    • 概要
    • Smart Mock
    • カスタムモック
    • モック優先順位
    • モックスクリプト
    • Cloud Mock
    • セルフホスト Runner モック
    • モック言語（ロケール）
  • アカウントと設定
    • アカウント設定
    • OpenAPI アクセストークンの生成
    • 通知
    • 言語設定
    • ホットキー
    • ネットワークプロキシ設定
    • データのバックアップ
    • Apidog の更新
    • アカウントの削除
    • 実験的機能
  • リクエスト送信
    • 概要
    • SSE デバッグ
    • MCP Client
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP または WebService
    • GraphQL
    • gRPC
    • デバッグにリクエストプロキシエージェントを使用する
    • リクエスト作成
      • リクエスト履歴
      • リクエストの基本
      • パラメータとボディ
      • リクエストヘッダー
      • リクエスト設定
      • リクエストのデバッグ
      • リクエストをエンドポイントとして保存する
      • HTTP/2
    • 認証と認可
      • 概要
      • CA 証明書とクライアント証明書
      • 認可タイプ
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk 認証
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • レスポンスとCookie
      • APIレスポンスの表示
      • Cookie の管理
      • 概要
  • APIの開発とデバッグ
    • 概要
    • リクエストの生成
    • リクエストの送信
    • デバッグケース
    • テストケース
    • 動的値
    • レスポンスの検証
    • Design-First と Request-First
    • コード生成
    • 環境と変数
      • 概要
      • 変数の使用
      • 環境管理
    • Vaultシークレット
      • 概要
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • 動的値モジュール
      • Airline
      • Animal
      • Color
      • Commerce
      • 会社
      • Database
      • データ型
      • 日付
      • Finance
      • Food
      • Git
      • Hacker
      • Helpers
      • 画像
      • Internet
      • Location
      • Lorem
      • 音楽
      • Number
      • Person
      • Phone
      • Science
      • 文字列
      • システム
      • Vehicle
      • Word
    • プリプロセッサとポストプロセッサ
      • 概要
      • アサーション
      • 変数の抽出
      • Wait
      • セキュリティ
      • データベース操作
        • 概要
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • スクリプトの使用
        • 概要
        • プリプロセッサスクリプト
        • ポストプロセッサスクリプト
        • Public Scripts
        • Postman Scripts Reference
        • 他のプログラミング言語の呼び出し
        • JS ライブラリの使用
        • レスポンスの可視化
        • スクリプト例
          • アサーションスクリプト
          • 変数の使用
          • リクエストの変更
          • その他の例
    • APIデバッグ
      • AI Agent Debugger
      • A2A Debugger
  • API設計
    • 概要
    • 新しい API プロジェクトを作成する
    • エンドポイントの基本
    • API設計ガイドライン
    • モジュール
    • 複数のリクエストボディ例を設定する
    • コンポーネント
    • 共通フィールド
    • グローバルパラメータ
    • エンドポイント変更履歴
    • コメント
    • エンドポイントの一括管理
    • カスタムプロトコル API
    • Spec-first Mode（ベータ）
    • セキュリティスキーム
      • 概要
      • セキュリティスキームを作成する
      • セキュリティスキームを使用する
      • オンラインドキュメントにおけるセキュリティスキーム
    • 高度な機能
      • カスタムエンドポイントフィールド
      • 関連するテストシナリオ
      • エンドポイントステータス
      • パラメータ一覧の表示形式
      • エンドポイントの一意識別
    • スキーマ
      • 概要
      • 新しいスキーマを作成する
      • スキーマを構築する
      • JSON などからスキーマを生成
      • oneOf、allOf、anyOf
      • Discriminator の使用
  • APIテスト
    • 概要
    • テストシナリオ
      • テストシナリオを作成する
      • リクエスト間でデータを受け渡す
      • フロー制御条件
      • エンドポイントおよびエンドポイントケースからデータを同期する
      • 他のプロジェクトからエンドポイントとエンドポイントケースをインポートする
      • テストシナリオのエクスポート
    • テストレポート
      • テストレポート
    • テストシナリオの実行
      • テストシナリオを実行する
      • テストシナリオを一括実行する
      • データ駆動テスト
      • 共有テストデータ
      • スケジュールされたタスク
      • 他のプロジェクトの API の実行環境を管理する
    • テストスイート
      • 概要
      • テストスイートを作成する
      • テストスイートを編成する
      • テストスイートをローカルで実行する
      • CLI でテストスイートを実行する
      • スケジュールタスク
    • APIのテスト
      • 統合テスト
      • パフォーマンステスト
      • エンドツーエンドテスト
      • 回帰テスト
      • コントラクトテスト
    • Apidog CLI
      • 概要
      • Apidog CLI のインストールと実行
      • Apidog CLI オプション
    • CI/CD
      • 概要
      • Github Actions との連携
      • Gitlab との統合
      • Jenkins との連携
      • Git コミットによるテストのトリガー
  • APIドキュメントの公開
    • 概要
    • サポートされているAPI技術
    • クイック共有
    • API ドキュメントの閲覧
    • Markdown ドキュメント
    • ドキュメントサイトの公開
    • カスタムログインページ
    • カスタムレイアウト
    • カスタム CSS、JavaScript、HTML
    • カスタムドメイン
    • AI 機能
    • SEO 設定
    • 詳細設定
      • ドキュメント検索
      • CORS プロキシ
      • Google Analytics の連携
      • フォルダツリー設定
      • 表示設定
      • ドキュメントURLへの値の埋め込み
    • APIバージョン
      • 概要
      • API バージョンの作成
      • API バージョンの公開
      • API バージョンを指定したエンドポイントの共有
  • ブランチ
    • 概要
    • スプリントブランチの作成
    • ブランチでAPIをテストする
    • ブランチで API を設計する
    • スプリントブランチのマージ
    • スプリントブランチの管理
    • AI Branch（ベータ）
  • AI機能
    • 概要
    • AI機能の有効化
    • テストケースの生成
    • AI によるスキーマの変更
    • エンドポイントコンプライアンスチェック
    • APIドキュメント完全性チェック
    • AIを活用したフィールド命名
    • FAQ
  • Apidog MCPサーバー
    • 概要
    • Apidog プロジェクトを AI に接続する
    • 公開済みドキュメントを AI に接続する
    • OpenAPI ファイルを AI に接続する
  • ベストプラクティス
    • API署名の処理
    • OAuth 2.0 で保護された API へのアクセス
    • コラボレーションワークフロー
    • 認証状態の管理
  • オフラインスペース
    • 概要
  • 管理
    • プロジェクト管理
      • プロジェクトの管理
      • 通知設定
      • プロジェクトメンバーの管理
      • プロジェクトリソース
        • データベース接続
        • Git 接続
    • チーム管理
      • チームの管理
      • チームメンバーの管理
      • チームアクティビティ
      • チームのロールと権限
      • チームリソース
        • General Runner
        • チーム変数
        • リクエストプロキシエージェント
      • リアルタイムコラボレーション
        • チームコラボレーション
    • オンボーディングチェックリスト
      • 基本概念
      • オンボーディングガイド
    • 組織管理
      • 組織の管理
      • 組織ロールと権限
      • プラン管理
        • 組織の請求管理者
      • シングルサインオン（SSO）
        • SSO 概要
        • Microsoft Entra ID の設定
        • Okta の設定
        • 組織の SSO を設定する
        • ユーザーアカウントの管理
        • グループをチームにマッピングする
      • SCIMプロビジョニング
        • SCIM プロビジョニングの概要
        • Microsoft Entra ID
        • Okta
      • 組織リソース
        • セルフホスト Runner
  • 請求
    • 概要
    • クレジット
    • プランのアップグレード
    • 代替支払い方法
    • サブスクリプションの管理
    • 有料チームの組織への移動
  • Apidog Europe
    • Apidog Europe
  • アドオン
    • API Hub
    • Apidog Intellij IDEA プラグイン
    • ブラウザ拡張機能
      • Chrome
      • Microsoft Edge
    • リクエストプロキシ
      • Web でのリクエストプロキシ
      • 共有ドキュメントにおけるリクエストプロキシ
      • クライアントでのリクエストプロキシ
  • データとセキュリティ
    • データストレージとセキュリティ
    • ユーザーデータのプライバシーとセキュリティ
    • リクエストルーティングとデータセキュリティ
  • リファレンス
    • APIデザインファーストアプローチ
    • Apidog OpenAPI 仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSON Schema
    • CSVファイル形式
    • Java 環境のインストール
    • Runner デプロイ環境
    • Apidog Markdown 構文
    • Apidog Swagger拡張
      • 概要
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Apidog JSON Schema拡張
      • 概要
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • サポートセンター
  1. プロジェクト管理

通知設定

通知の概要#

Apidog では、サードパーティアプリケーションと連携し、特定のイベントが発生した際に指定した受信者へ通知を送信できます。特定のイベントがトリガーされると、Slack などのプラットフォームへリアルタイムで通知が送信されます。現在サポートされている通知チャネルは次のとおりです。
Slack
Teams
Webhook
Jenkins
Email
通知設定を構成できるのは、プロジェクト管理者のみです。現在、メール通知は次のイベントでのみ利用できます。
自動テストの完了/失敗
継続的インテグレーションの完了/失敗
スケジュールタスクの完了/失敗

通知ターゲット#

通知ターゲットとは、特定のイベントが発生した際に、特定のチャネルを通じてメッセージを受信する受信者のことです。
通知を設定するには、まず名前を指定し、チャネルを選択し、その設定を構成して通知ターゲットを作成する必要があります。各チャネルには固有の設定手順があります。以下のセクションでは、それぞれの設定方法を順を追って説明します。
通知設定.png

Slack#

Apidog は、Slack アプリ - 指定した Channel の Incoming WebHooks と連携し、Incoming WebHooks の Webhook URL を設定することで、通知イベントを Slack の特定の Channel に送信することをサポートしています。これにより、イベントメッセージを Slack Channel に送信できます。
設定フィールドの説明:
設定フィールド必須説明
Notification Nameいいえサードパーティ連携通知に名前を付け、その目的を記録します。
Trigger Eventsはいサポートされるイベント: API 変更、スキーマ変更、ドキュメント変更、データのインポート、自動化テスト
Service URLはい"Incoming WebHooks - Integration Settings" 内の Webhook URL

Apidog 通知を Slack と連携する#

プロジェクト管理者は、サードパーティ連携機能を使用して、Slack の Channels に追加された Slack アプリ - Incoming WebHooks を Apidog のプロジェクト通知イベントに関連付けることができます。これにより、関連する API 変更、ドキュメント変更、テスト完了などを Slack の指定した Channel にプッシュできます。
ステップ 1: チャネル詳細を開く
Slack チャネルで、右上の "Open channel details" オプションをクリックします。
CleanShot 2024-12-03 at 15.41.54@2x.png
ステップ 2: Incoming WebHook をインストールする
特定の Channel の Integrations - Apps で、Incoming WebHook をインストールして追加します。
ステップ 3: Incoming WebHooks を表示する
インストールが完了したら、Incoming WebHooks - View の右側にあるボタンをクリックします。
ステップ 4: Incoming WebHooks を設定する
これにより Incoming WebHooks の説明ページが開きます。Configuration をクリックして設定します。
ステップ 5: Slack に追加する
Add to Slack をクリックします。
ステップ 6: Channel を選択して連携を追加する
Apidog の通知イベントメッセージをプッシュする Channel を選択し、Add Incoming WebHooks integration をクリックします。
ステップ 7: Webhook URL を取得する
Webhook URL を取得してコピーします。
ステップ 8: Apidog で通知ターゲットを作成する
"Settings" > "Notifications" > "Notification Targets" > をクリックし、新しい通知 Target を作成します。
新しい Slack 通知ターゲットを作成.png
通知ターゲット名を入力します。
通知チャネルとして Slack を選択します。
Incoming WebHooks 設定から取得した Webhook URL を Service URL に貼り付けます。
Save をクリックすると、設定は完了です。次に 通知イベントを作成する に進むことができます。
通知イベントが設定されてトリガーされると、指定した Slack チャネルでメッセージを受信します。

Teams#

Microsoft Teams への通知送信をサポートしており、Teams の Workflows でこれらのメッセージを以降のアクションのトリガーとして使用できます。たとえば、グループやチャネルにメッセージを自動投稿することで、チームが Apidog からの重要なイベントを把握しやすくなります。
具体的には、Workflow 内に Webhook Trigger を設定できます。Apidog で特定の通知イベントがトリガーされると（例: API 変更、ドキュメント更新、自動テスト完了）、Apidog はイベントペイロードを含む POST リクエストを、トリガーの指定された HTTP POST URL に送信します。
設定フィールド:
フィールド必須説明
Nameはいこの通知ターゲットの目的を説明する名前
HTTP POST URLはいWorkflow 内の Webhook Trigger が POST リクエストを受信する URL

Apidog 通知を Teams Channels と連携する#

ステップ 1: Teams でワークフローを作成する
Microsoft Teams → Workflow で Create をクリックします。テンプレート Post to a channel when a webhook request is received を選択すると、すぐに開始できます。
画像.png
ステップ 2: フロー名とアカウントを設定する
フローの名前を設定し、適切なアカウントを選択して、Next をクリックします。
画像.png
ステップ 3: グループとチャネルを選択する
通知を受信するグループとチャネルを選択し、Create flow をクリックします。
画像.png
ステップ 4: HTTP POST URL を取得する
フローが作成されると、トリガーステップの下に HTTP POST URL が表示されます。直接コピーすることも、後でフローのトリガーステップ内で確認することもできます。
画像.png
画像.png
ステップ 5: Apidog で通知ターゲットを設定する
この HTTP POST URL を Apidog の通知ターゲット設定に貼り付けます。
CleanShot 2025-06-10 at 11.55.15@2x.png
ステップ 6: 通知イベントを作成する
Apidog で通知イベントを作成し、設定済みの Teams 通知ターゲットに関連付けます。
CleanShot 2025-06-10 at 11.55.59@2x.png
ステップ 7: Teams 通知を確認する
この通知イベントがトリガーされると、以前作成したワークフローが、選択した Teams チャネルにメッセージを自動投稿します。
画像.png

Webhook#

HTTP Server への通知イベントの送信をサポートしています。POST リクエストを受信する URL アドレスを指定することで、イベントメッセージを HTTP Server に送信できます。
設定フィールドの説明:
設定フィールド必須説明
Notification Nameいいえサードパーティ連携通知に名前を付け、通知の目的を記録します。
Trigger Eventはいサポートされるイベント: API 変更、データモデル変更、ドキュメント変更、データのインポート、自動化テスト
Server URLはいリクエストを受信する HTTP Server の URL アドレス
Signature Authいいえ送信される内容は、トークンを KEY として使用する HMAC SHA1 暗号化アルゴリズムによって暗号化され、値は 16 進数で表示されます（設定済みトークンが必要です）。また、プレフィックス sha1= が含まれます。

Apidog 通知をセルフホスト HTTP Server と連携する#

プロジェクト管理者は、サードパーティ連携を使用して、自身のセルフホスト HTTP Server を Apidog のプロジェクト通知イベントに関連付けることができます。これにより、関連する API 変更、ドキュメント変更、自動化テスト完了の通知を HTTP Server で受信できます。
Apidog 通知をセルフホスト HTTP Server と連携するには、"Settings" > "Notifications" > "Notification Targets" > をクリックし、新しい通知 Target を作成します。
新しい Webhook 通知ターゲットを作成.png
1.
通知ターゲット名を入力します。
2.
チャネルとして Webhook を選択します。
3.
セルフホスト HTTP Server の URL を Service URL フィールドに貼り付けます。
4.
署名検証が有効になっている場合は、キーをコピーして Signature Key フィールドに貼り付けます。
Save をクリックすると、設定は完了です。次に 通知イベントを作成する に進むことができます。

Jenkins#

Jenkins サービスへの通知イベントの送信をサポートしています。Jenkins Webhook URL を設定することで、イベントメッセージを Jenkins に送信できます。
設定フィールドの説明:
設定フィールド必須説明
Notification Nameいいえサードパーティ連携通知に名前を付け、その目的を記録します。
Trigger EventsはいAPI 変更、データモデル変更、データのインポート、自動化テスト。上記のいずれかのイベントが発生すると、リアルタイム通知がトリガーされます。
Service URLはいURL は Generic Webhook Trigger プラグインで設定されます。
Signature AuthいいえAuthorization Bearer ヘッダーを介して Generic Webhook Trigger プラグインに送信されます。

Apidog 通知を Jenkins サービスと連携する#

プロジェクト管理者は、サードパーティ連携機能を使用して、Jenkins の Generic Webhook Trigger プラグインで設定された Webhook URL を Apidog のプロジェクト通知イベントに関連付けることができます。これにより、API 変更、ドキュメント変更、自動化テスト完了などのイベントがトリガーされた際に、Jenkins でビルドアクションを自動的にトリガーし、ビルド履歴でメッセージを確認できます。
ステップ 1: Jenkins Generic Webhook Trigger プラグインで Webhook URL を設定する
Jenkins Dashboard で新しいビューを作成します。
前のステップのビューをクリックして Configure>Build Triggers に入り、Generic Webhook Trigger を選択します。Webhook URL は "http://"+"your service address"+"/generic-webhook-trigger/invoke" です。
カスタムトークンがサポートされています。
ステップ 2: 新しい通知ターゲットを作成する
"Settings" > "Notifications" > "Notification Targets" > をクリックし、新しい通知 Target を作成します。
通知設定 Jenkins.png
通知ターゲット名を入力します。
チャネルとして Jenkins を選択します
Generic Webhook Trigger プラグインで設定した Webhook URL を Service URL フィールドに貼り付けます
カスタムトークンを使用する場合は、Token をコピーして Signature Token フィールドに貼り付けます。
Save をクリックすると、設定は完了です。次に 通知イベントを作成する に進むことができます。
通知イベントが設定されてトリガーされると、Jenkins はビルドアクションを自動的に開始し、ビルド履歴でメッセージを確認できます。

Email#

指定したメールアドレスにメールで通知を送信できます。現在、メール通知は次のイベントでのみ利用できます。
自動テストの完了/失敗
継続的インテグレーションの完了/失敗
スケジュールタスクの完了/失敗
設定フィールドの説明:
フィールド必須詳細
Nameはい通知ターゲットの目的または特徴を示す説明的な名前です。
Notification Email Addressはい通知を受信するメールアドレスを入力します。プロジェクトメンバーのメールアドレスを選択することも、手動でアドレスを入力することもできます。複数のメールアドレスがサポートされています。

Apidog 通知を Email と連携する#

通知設定 Email.png
1.
通知ターゲット名を入力します。
2.
チャネルとして Email を選択します
3.
メールアドレスを入力します
Save をクリックすると、設定は完了です。次に 通知イベントを作成する に進むことができます。

通知イベント#

通知イベントを作成すると、どのイベントが指定した受信者（通知ターゲット）への通知をトリガーするかを指定できます。通知イベントを設定するには、次を構成する必要があります。
通知イベント名
トリガーイベント
通知ターゲット
通知イベントの作成.png

トリガーイベント#

通知をトリガーする通知イベントは、次から選択できます。
トリガーイベント詳細
エンドポイント変更エンドポイント作成
エンドポイント更新
エンドポイント削除
スキーマ変更スキーマ作成
スキーマ更新
スキーマ削除
ドキュメント変更ドキュメント作成
ドキュメント更新
ドキュメント削除
データインポートインポート（手動インポート）
インポート（自動同期）
レスポンスコンポーネント変更レスポンスコンポーネント作成
レスポンスコンポーネント更新
レスポンスコンポーネント削除
スプリントブランチ変更スプリントブランチのマージ
スプリントブランチ作成
スプリントブランチのアーカイブ
スプリントブランチ削除
スプリントブランチ取得
API バージョン変更API バージョン作成
API バージョン削除
セキュリティスキーム変更セキュリティスキーム作成
セキュリティスキーム更新
セキュリティスキーム削除
TIP
自動テストに関連する通知（例: 自動テスト完了、継続的インテグレーション完了、スケジュールタスク完了）については、各テストシナリオごとに個別に設定を構成する必要があります。この方法はより柔軟で、実際のユースケースにより適しています。

通知ターゲット#

トリガーイベントが発生した際に通知を受信する通知ターゲットを選択します。プロジェクト内で既に設定されている通知ターゲットから選択でき、必要に応じて複数のターゲットを選択できます。
ただし、メール通知は次の 3 つの特定イベントでのみサポートされています。
自動テストの完了/失敗
継続的インテグレーションの完了/失敗
スケジュールタスクの完了/失敗
通知イベントのターゲット設定を作成.png
Modified at 2026-06-11 07:06:02
Previous
プロジェクトの管理
Next
プロジェクトメンバーの管理
Built with