Webhook と API キー(外部のサービスとの連携)
予約の登録・変更を外部のサービスに送る Webhook の設定と、API キーの発行・無効化を説明します。
予約の情報を、チャット(Slack・Microsoft Teams・Google Chat・Chatwork)や顧客管理のシステム・自社のサーバーなど外部のサービスに送る方法です。
通知の送信先(チャット・Webhook)
予約が登録・変更されたときなどに、院が登録した送信先に通知を送ります(10 件まで)。送信に失敗した場合は自動で再送します。設定は「院の設定」の「Webhook」タブで行います。追加・変更はオーナー・管理者のみ行えます(編集者の方は一覧の確認のみ行えます)。
| 種類 | 入力するもの |
|---|---|
| Slack | Incoming Webhook の URL(Slack の「Incoming Webhook」で投稿先のチャンネルを選んで発行) |
| Microsoft Teams | ワークフローの URL(チャネルの「ワークフロー」で「Webhook 要求を受信したらチャネルに投稿する」を作成) |
| Google Chat | スペースの Webhook URL(スペース名のメニューの「アプリと統合」→「Webhook を追加」) |
| Chatwork | ルーム ID と API トークン(投稿はトークンの持ち主の名前で行われます) |
| Webhook | 受信するシステムの URL(https)。署名付きの JSON(Standard Webhooks)で送ります |
- 「Webhook」タブの「+ 送信先を追加」を押し、種類を選んで URL などを入力します。
- 「受け取る通知」で、送る通知を選びます(初めは予約の登録・変更・取り消し・来院受付・前日のリマインドを選んでいます)。
- 「追加」を押します。Webhook の場合は署名シークレット(whsec_…)が表示されます。受信する側で署名を検証するための鍵で、この表示を閉じると再表示できないため、控えてから閉じてください。
- 「テスト送信」を押して、見本の予約(題の頭に【テスト】)が送信先に届くことを確認します。
一覧の「一時停止」で送信を止め、「再開」で戻します。「受け取る通知を変更」で、送る通知を選び直せます。送信できない状態が続いた送信先は自動で停止し、一覧に理由を表示します。送信先の設定を確認してから「再開」を押してください。
| 通知の内容 | イベント種別(event_type) |
|---|---|
| 予約の登録 | appointment.created |
| 予約の日時・ベッドの変更 | appointment.rescheduled |
| 予約の取り消し | appointment.cancelled |
| 来院受付(来院済み) | appointment.arrived |
| 前日のリマインド(毎日 17 時に翌日の予約ごと) | appointment.reminder |
| タブレットからのスタッフ呼び出し | kiosk.staff_called |
| 待合室の画面への呼び出し | waiting.called |
| 待合室の画面のお知らせ | waiting.notice |
受付で登録・変更した予約も含め、すべての経路の予約について送ります。チャットには、日時・お名前・内容・ベッド・場所などを読みやすい形で投稿します。Webhook の本文には、予約の情報(appointment)と、チャットと同じ文(title・text・lines・link)が入ります。
API キー
外部のサービスから、予約の空きの確認や予約の登録を行うためのキーです。左のメニューの「API キー」で発行します。発行・無効化はオーナー・管理者のみ行えます(編集者の方は一覧の確認のみ行えます)。
- 「API キー」の画面で「名前」(連携先が分かる名前・50 文字まで)を入力し、「+ 発行」を押します。
- 「発行したキー(この画面でしか表示されません)」に表示されたキーをコピーし、連携先のサービスに設定します。
キーは発行した画面でしか表示されません。キーを知っている人は予約の確認・登録ができるため、安全な場所に保管してください。
使わなくなったキーや漏れたおそれのあるキーは「無効にする」を押します。そのキーを使っている連携では、直ちに予約の確認・登録ができなくなります。無効にしたキーは元に戻せません。引き続き利用する場合は、新しいキーを発行して設定し直してください。
Claude などの AI から操作する場合は、API キーではなく MCP で接続します(AI から操作する)。
最終更新日: