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

ウェブフック設定

ウェブフックは、ABC User Feedbackで特定のイベント発生時に外部システムに自動通知を送信する機能です。フィードバック作成、イシューステータス変更などのイベントをリアルタイムで外部サービス（Slack、Discord、独自サーバーなど）に配信できます。詳細な統合ガイドについては、ウェブフック統合ドキュメントを参照してください。

webhook-setting

アクセス方法​

  1. 上部メニューでSettingsをクリック
  2. 左メニューからWebhook Integrationを選択

Webhook Integration画面の概要​

webhook-list.png

ウェブフック統合画面は次のように構成されます：

ウェブフックリストテーブル構成​

列説明
On/Offウェブフック有効化/無効化トグルスイッチ
Nameウェブフック名
URL通知を受信する外部エンドポイント
Event Trigger購読中のイベントトリガー
Createdウェブフック作成日時

新しいウェブフックの作成​

1. ウェブフック登録開始​

右上のRegister Webhookボタンをクリックすると、ウェブフック登録モーダルが開きます。

2. 基本情報入力​

必須入力項目​

項目説明
Nameウェブフック識別のための名前
URLHTTP POSTリクエストを受信するエンドポイント

3. トークン設定（オプション）​

Tokenフィールドで認証用のトークンを設定できます：

  • Generateボタンをクリックして自動生成
  • または直接トークン値を入力

4. Event Trigger選択​

購読するイベントをチャネル別に選択できます：

サポートされるイベントタイプ​

各チャネル（VOC、Review、Survey、VOC Test）について、次のイベントを選択できます：

イベントタイプ説明
Feedback Creation新しいフィードバックが登録されたとき
Issue Registration新しいイシューが作成されたとき
Issue Status Changeイシューステータスが変更されたとき
Issue Creationイシューがフィードバックにリンクされたとき

5. ウェブフック保存​

すべての情報を入力した後：

  1. OKボタンをクリックしてウェブフックを作成
  2. Cancelボタンでキャンセル可能

ウェブフックステータス管理​

有効化/無効化の切り替え​

ウェブフックリストで各ウェブフックのOn/Off列にあるトグルスイッチをクリックしてステータスを変更できます：

  • On（有効化）: イベント発生時にリアルタイム送信
  • Off（無効化）: ウェブフックは維持されますが送信は停止

一時無効化シナリオ​

  • 外部サーバーがメンテナンス中の場合
  • ウェブフックURL変更作業中の場合
  • スパム通知を防ぐ必要がある場合

ウェブフック編集と削除​

ウェブフック編集​

ウェブフックリストで編集したいウェブフックをクリックすると編集モーダルが開きます：

編集可能な項目​

  • ウェブフック名
  • Target URL変更
  • トークン値修正
  • イベントタイプ追加/削除

ウェブフック削除​

ウェブフックを完全に削除するには：

  1. 編集モーダルで削除オプションを選択
  2. またはリストから直接削除ボタンをクリック（UIに削除ボタンがある場合）

ウェブフックテストと検証​

手動検証方法​

  1. フィードバック作成テスト：
    • テストフィードバックを登録してFeedback Creationイベントを確認
  2. イシュー管理テスト：
    • イシューを作成またはステータスを変更して関連イベントを確認
  3. 外部サービス確認：
    • Slack、Discordなどでメッセージ受信を確認

一般的な統合例​

Slackウェブフック設定​

Name: Slack通知
URL: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXX
Events: Feedback Creation, Issue Registration（すべてのチャネル）

Discordウェブフック設定​

Name: Discord開発チーム通知
URL: https://discord.com/api/webhooks/123456789/abcdefghijk
Events: Issue Status Change（VOCチャネルのみ）

カスタムサーバー統合​

Name: 内部分析システム
URL: https://api.yourcompany.com/webhooks/feedback
Token: your-generated-token
Events: すべてのイベント（すべてのチャネル）

関連ドキュメント​