書類の操作を条件に他システムへデータを自動送信する「Webhook」機能の設定方法について詳しく説明します。Webhookを利用することで、Styleflowでの操作をトリガーに外部システムで特定の処理を実行することが可能になります。
📊 Webhook機能の概要
Webhook機能は、Styleflowでの書類操作（申請、承認、承認完了等）を条件に、指定した外部システムのURLに対して自動的にデータを送信する機能です。
💡 主な活用例
- チャット通知：承認完了時にSlackやTeamsにメッセージ送信
- 外部システム連携：申請データを他システムに自動転送
- ワークフロー連動：承認状況に応じて関連システムの処理を実行
- データ統合：承認完了データを外部データベースに蓄積
🔧 Webhook設定の手順
前提条件：送信先となる外部システムのWebhook URLが準備されていること
手順1：書類情報画面にアクセス
- 「管理」メニューから「書類」を選択し、「書類情報｜一覧」画面に移動
- Webhookを設定したい書類の「書類ID」をクリックして「書類情報｜詳細」画面に移動
手順2：Webhook設定を有効化
- 「編集」ボタンを押下
- 「Webhook・個別アラート設定」グループを展開（「+」アイコンをクリック）
- 「Webhook」にチェックを入れる
- 「更新」ボタンを押下して設定を保存
手順3：Webhook詳細設定
- 「書類情報｜詳細」画面に戻り、「Webhook設定」リンクをクリック💡 注意
「Webhook設定」リンクは、Webhookにチェックが付いている書類にのみ表示されます。 - 「Webhook設定｜一覧」画面で「新規作成」ボタンを押下
- 「Webhook設定｜詳細」画面で以下の項目を設定：
📝 Webhook設定項目の詳細
| 設定項目 | 説明 | 備考 |
|---|---|---|
| Webhook名 | 設定するWebhookの識別名 | 必須入力 |
| WebhookURL | データ送信先の外部システムURL | 必須入力・HTTPS形式のみ |
| 通知を送信するトリガー | Webhookを実行するタイミング | 複数選択可能 |
| シークレットトークン | 認証用のトークン | 任意入力・セキュリティ強化に推奨 |
| 通知設定 | Webhookの有効/無効切り替え | チェック時のみ実行 |
| 説明 | Webhookの用途や説明 | 任意入力 |
⚡ トリガーの種類と実行タイミング
📋 利用可能なトリガー
- ✅ 申請時：新規申請が提出された時
- ✅ 承認時：各ステップで承認が実行された時
- ✅ 承認完了時：最終承認が完了した時
- ✅ 却下時：申請が却下された時
- ✅ 取り消し時：申請が取り消された時
- ✅ 保存時：申請データが保存された時
- ✅ 代理承認依頼時：代理承認が依頼された時
- ✅ 承認者再設定時：承認者が変更された時
- ✅ 回覧済み時：回覧が完了した時
- ✅ 回覧者再設定時：回覧者が変更された時
- ✅ 否決時：申請が否決された時
⚠️ 重要な注意点
承認が完了した場合は「承認完了時」がトリガーとして実行されます。「申請時」「承認時」「承認者再設定時」が設定されていても「承認完了時」が設定されていなければ、最終承認時にWebhookは実行されません。
承認が完了した場合は「承認完了時」がトリガーとして実行されます。「申請時」「承認時」「承認者再設定時」が設定されていても「承認完了時」が設定されていなければ、最終承認時にWebhookは実行されません。
🔐 セキュリティ設定（シークレットトークン）
🛡️ シークレットトークンの活用
- 目的：WebhookリクエストがStyleflowから送信されたことを証明
- 仕組み：リクエストヘッダーに「X-Styleflow-Token」として送信
- 推奨事項：ランダムな文字列を使用してセキュリティを強化
- 確認方法：受信側でヘッダー値を比較して送信元を検証
📊 送信されるデータの構成
Webhookで送信されるデータはJSON形式で、以下の主要な情報が含まれます：
🔄 主要データ項目
- ✅ record_info：申請書類の詳細情報（フォーム項目の値等）
- ✅ reference_info：参照書類一覧
- ✅ approval_status_info：承認状況一覧
- ✅ document_info：書類情報（書類ID、名称、版数等）
- ✅ url_info：各申請書類画面へのリンク
- ✅ action_info：Webhookの実行情報
- ✅ status_transition_info：ステータス遷移情報
✅ ベストプラクティス
| 🔒 | セキュリティ重視：シークレットトークンを必ず設定し、HTTPS URLのみ使用 |
| 🎯 | 明確な命名：Webhook名は用途が分かりやすい名前を設定 |
| ⏰ | 適切なトリガー選択：必要なタイミングのみでWebhookを実行 |
| 🧪 | 事前テスト：本番運用前に必ずテスト環境で動作確認 |
| 📝 | 詳細な説明記載：後から設定内容が分かるよう詳細を記録 |
🎯 まとめ
Webhook機能により、Styleflowと外部システムの連携が実現できます。
🔑 成功のポイント
- 「通知を送信するトリガー」と「通知設定」の両方を適切に設定
- セキュリティ強化のためシークレットトークンを活用
- 送信されるJSONデータ構造を理解して受信側システムを構築
この記事はお役に立ちましたか？ 他のシステム連携についても詳しく知りたい場合は、関連記事をご確認ください。