コンテンツにスキップ
Wink

Webhook連携

Webhookを使うと、Winkアカウントで発生した新しい予約、キャンセル、支払いの更新などのイベントをリアルタイムでシステムに通知できます。このガイドでは、設定方法とベストプラクティスを説明します。

対象読者

Section titled “対象読者”

このガイドは、Winkを物件管理システム（PMS）、チャネルマネージャー、CRM、カスタムダッシュボードなどの外部システムと連携する開発者向けです。

Webhookの仕組み

Section titled “Webhookの仕組み”
  1. WinkにWebhookのURLを登録します。
  2. イベントが発生すると（例：新しい予約）、WinkがあなたのURLにHTTP POSTを送信します。
  3. サーバーがペイロードを処理し、200 OKで応答します。

Webhookの設定

Section titled “Webhookの設定”
  1. アカウントにログインします（Extranet、Studio、TripPayのいずれもWebhookをサポートしています）。
  2. Applications に移動し、次に Webhooks を選択します。Webhooksを参照してください。
  3. Create webhook をクリックします。
  4. 名前 を入力します（例：「PMS予約同期」）。
  5. Webhook URL を入力します — サーバーのHTTPSエンドポイントです。
  6. イベントを選択 — 購読する特定のイベントを選ぶか、すべてのイベントを受け取る場合は空欄のままにします。
  7. Enabled をオンに切り替えます。
  8. Save をクリックします。

イベントタイプ

Section titled “イベントタイプ”

Winkはアカウント管理、予約契約、支払い、チャネルマネージャーの更新、管理エンティティの管理などのカテゴリで64以上のWebhookイベントタイプをサポートしています。よく使われるイベントは以下の通りです：

カテゴリ例
予約booking.create, booking.cancelled
予約契約booking.contract.created, booking.contract.processing, booking.contract.cancelled
支払いinternal.payment.succeeded, internal.payment.failed
返金booking.contract.refund.partial, booking.contract.refund.full
チャネルマネージャーchannel-manager.update.rate, channel-manager.update.availability
アカウントaccount.create, account.status.updated

すべてのイベントタイプと説明の完全なリストは、Webhookイベントカタログをご覧ください。

64以上のすべてのイベントタイプを見る

ベストプラクティス

Section titled “ベストプラクティス”
  • HTTPSを使用する — WinkはHTTPSエンドポイントにのみペイロードを送信します。
  • 迅速に応答する — ペイロードを受け取ったらすぐに200 OKを返してください。重い処理は非同期で行いましょう。
  • 冪等性 — ハンドラーは冪等であるべきです。Winkは200応答がない場合、再送を試みることがあります。
  • 送信元の検証 — 処理前にリクエストがWinkからのものであることを確認してください。
  • ログ記録 — 受信したWebhookペイロードはすべてログに記録しましょう。統合の問題をデバッグしやすくなります。

一時停止と削除

Section titled “一時停止と削除”

Webhookは削除せずに無効化できます。これにより配信が一時停止し、設定を失うことなくトラブルシューティングが可能です。準備ができたら再度オンに切り替えます。

Webhookを削除すると完全に削除されます。そのWebhookに依存している統合は通知を受け取れなくなります。

参考資料

Section titled “参考資料”