Webhook と API キー(外部のサービスとの連携)
予約の登録・変更を外部のサービスに送る Webhook の設定と、API キーの発行・無効化を説明します。
予約の情報を、顧客管理のシステム・チャット・自社のサーバーなど外部のサービスと連携する方法です。
Webhook(予約の情報を外部に送る)
予約が登録・変更されたときに、医院が登録した URL に知らせを送ります。送信に失敗した場合は自動で再送します。設定は「医院の設定」の「Webhook」タブで行い、院長・管理者のみ利用できます。
| 通知の内容 | イベント種別(event_type) |
|---|---|
| 予約の登録 | appointment.created |
| 予約の日時・診察室の変更 | appointment.rescheduled |
| 予約の取り消し | appointment.cancelled |
| 来院受付(来院済み) | appointment.arrived |
| 前日のリマインド(毎日 17 時に翌日の予約ごと) | appointment.reminder |
| タブレットからのスタッフ呼び出し | kiosk.staff_called |
- 「Webhook」タブの「送信先を設定」を押します。送信先の設定画面が新しいタブで開きます(リンクは 15 分間有効です。期限が切れた場合はもう一度押してください)。
- 設定画面で、送信先の URL と受け取るイベント種別を登録します。署名の鍵の確認や、送信の履歴の確認もこの画面で行います。
Webhook は、受付で登録・変更した予約も含め、すべての経路の予約について送ります。
LINE 連携を使っている場合は、「LINE 通知(AIリザーブ)」の送信先を削除しないでください。LINE でのお知らせが届かなくなります(LINE 連携)。
API キー
外部のサービスから、予約の空きの確認や予約の登録を行うためのキーです。左のメニューの「API キー」で発行します。発行・無効化は院長・管理者のみ行えます(受付の方は一覧の確認のみ行えます)。
- 「API キー」の画面で「名前」(連携先が分かる名前・50 文字まで)を入力し、「+ 発行」を押します。
- 「発行したキー(この画面でしか表示されません)」に表示されたキーをコピーし、連携先のサービスに設定します。
キーは発行した画面でしか表示されません。キーを知っている人は予約の確認・登録ができるため、安全な場所に保管してください。
使わなくなったキーや漏れたおそれのあるキーは「無効にする」を押します。そのキーを使っている連携では、直ちに予約の確認・登録ができなくなります。無効にしたキーは元に戻せません。引き続き利用する場合は、新しいキーを発行して設定し直してください。
Claude などの AI から操作する場合は、API キーではなく MCP で接続します(AI から操作する)。
最終更新日: