Webhooks

ウェブフック

コンテストイベントのリアルタイム通知を受け取る

ウェブフック

ウェブフックは、外部サービスがあなたのアプリケーションでイベントが発生したときにBlitz Rocketにデータを送信できる仕組みです。ユーザーがプラットフォームにサインアップした際に自動でコンテストエントリーを作成したり、購入があった際にポイントを付与したりするためにウェブフックを利用してください。

ウェブフックの仕組み

  1. 外部システム(例:Shopify、Stripe、またはカスタムバックエンド)にウェブフックURLを設定する
  2. イベントが発生すると(サインアップ、購入など)、システムがBlitz RocketのウェブフックエンドポイントにHTTP POSTリクエストを送信する
  3. Blitz Rocketがイベントを処理し、エントリーを作成または更新し、ポイントを付与する

利用可能なウェブフックエンドポイント

ウェブフックエンドポイント用途
サインアップPOST /api/webhooks/signup/:contestId外部サインアップからエントリーを作成
購入POST /api/webhooks/purchase/:contestId外部ストアからの購入を追跡

ウェブフックのセキュリティ

各ウェブフック接続には、チーム設定で構成できるシークレットキーがあります。ウェブフックリクエストを送信する際は、リクエストボディまたはヘッダーにシークレットを含めて真正性を検証してください。

対応インテグレーション

Blitz Rocketは以下のウェブフックをサポートしています:

  • Shopify — 自動注文および顧客ウェブフック
  • Stripe — 支払いおよびサブスクリプションウェブフック
  • カスタム — HTTP POSTリクエストを送信できる任意のシステム

ウェブフックとAPIの違い

機能ウェブフックREST API
方向性外部 → Blitz Rocketあなたのコード → Blitz Rocket
認証ウェブフックシークレットAPIキー
利用ケースイベント駆動の自動化オンデマンド操作
リアルタイムあり(プッシュ)なし(プル)

自動化されたイベント駆動のエントリー作成や購入追跡にはウェブフックを使用してください。操作を細かく制御したい場合はREST APIを利用してください。