Webhook連携
Webhookを使うと、Winkアカウントで発生した新しい予約、キャンセル、支払いの更新などのイベントをリアルタイムでシステムに通知できます。このガイドでは設定方法とベストプラクティスを説明します。
このガイドは、Winkを物件管理システム（PMS）、チャネルマネージャー、CRM、カスタムダッシュボードなどの外部システムと連携する開発者向けです。
Webhookの仕組み
Section titled “Webhookの仕組み”- WinkにWebhookのURLを登録します。
- イベントが発生すると（例：新しい予約）、WinkがあなたのURLにHTTP POSTを送信します。
- あなたのサーバーがペイロードを処理し、
200 OKで応答します。
Webhookの設定
Section titled “Webhookの設定”- アカウントにログインします（Extranet、Studio、TripPayのいずれもWebhookをサポートしています）。
Applicationsに移動し、次にWebhooksを選択します。Webhooksを参照してください。Create webhookをクリックします。- 名前 を入力します（例：「PMS予約同期」）。
- Webhook URL を入力します — あなたのサーバーのHTTPSエンドポイント。
- イベントを選択 — 購読したい特定のイベントを選ぶか、すべてのイベントを受け取る場合は空欄のままにします。
- 有効 をオンに切り替えます。
Saveをクリックします。
イベントタイプ
Section titled “イベントタイプ”Winkはさまざまなイベントタイプをサポートしています。一般的なイベントは以下の通りです：
- 予約作成 — 新しい予約が確定しました。
- 予約キャンセル — 予約がキャンセルされました。
- 支払い完了 — 支払いが処理されました。
- 予約更新 — 予約の詳細が変更されました。
ベストプラクティス
Section titled “ベストプラクティス”- HTTPSを使用する — WinkはHTTPSエンドポイントにのみペイロードを送信します。
- 迅速に応答する — ペイロードを受け取ったらすぐに
200 OKを返してください。重い処理は非同期で行いましょう。 - 冪等性 — ハンドラーは冪等であるべきです。Winkは
200応答がない場合、再送を試みることがあります。 - 送信元の検証 — 処理前にリクエストがWinkからのものであることを確認してください。
- ログ記録 — 受信したWebhookペイロードはすべてログに記録しましょう。統合の問題解決が容易になります。
一時停止と削除
Section titled “一時停止と削除”Webhookを無効化することで削除せずに配信を一時停止できます。設定を失わずにトラブルシューティングが可能です。準備ができたら再度有効に切り替えましょう。
Webhookを削除すると完全に削除されます。そのWebhookに依存している統合は通知を受け取れなくなります。
- Webhooks — Webhook管理の完全リファレンス。
- Applications — API認証情報の管理。
- Developers > APIs — APIの完全ドキュメント。