Vivoldi Webhook — リアルタイムイベント配信

ビボルディのWebhookは、イベント検知 → 署名生成 → HTTPS送信 → 受信確認の4ステップで動作します。

グローバルWebhookを設定しただけでは、イベントは送信されません。 グローバル設定では、イベント送信に使用するデフォルトのCallback URLとSecret Keyを設定します。 イベントが送信されるのは、対象のリンク・クーポン・スタンプカードでWebhookを有効にした場合のみです。

リンクグループ・クーポングループ・スタンプカードに個別のWebhookが設定されている場合は、その設定がグローバル設定より優先されます。 グローバル設定と個別設定の両方が有効でも、同じイベントが重複して送信されることはありません。

レスポンスのステータスコードが2xx以外の場合、または5秒以内に応答がない場合は、送信失敗として処理されます。 失敗したリクエストはレスポンスのステータスコードに関係なく再試行されるため、1回の送信失敗だけでWebhookが停止することはありません。

送信に失敗しても、Webhookがすぐに停止することはありません。
まずメールで送信失敗を通知し、その後60分間の猶予期間を設けます。 この間に受信サーバーが復旧すれば、Webhookを停止せずに送信を継続します。

同じ受信先で継続的な送信失敗が発生した場合、一時的に送信を停止し、状態確認用のテスト送信を行ってサーバーが復旧しているか確認します。
応答しない受信サーバーにリクエストが蓄積し続けないよう管理し、お客様側のデプロイや一時的な障害など短時間の停止は自動的に解消されます。

クーポン利用・スタンプ付与イベントが失われることはありません。
一度だけ発生する重要なイベントであるため、送信リトライ中やレート制限が発生した場合はキューに保存し、送信可能になり次第、順番に配信します。
リンククリックイベントは繰り返し発生し、すべての分析データはビボルディに保存されるため、一時的な送信制限中に追加送信は行いません。

Webhookの状態は3種類で管理されます。
一覧画面のWebhookフィルターを使用すると、状態別にWebhookを確認できます。

• 有効 Webhookが正常に動作し、イベントが送信されている状態です。
• 無効 ユーザーが手動で無効にした状態です。
• システム停止 継続的な送信失敗により、ビボルディが自動的に停止した状態です。停止時にはメールで通知します。

システム停止状態は、受信サーバーの問題を解決した後、ダッシュボードから再度有効にできます。
有効化後は新しいイベントから送信が再開され、停止中に発生したイベントは以前のポリシーに従って処理されます。

Webhookはプレミアムプラン以上で利用できます。 利用可能なWebhook数は、Webhookを有効化できる対象数を基準に制限されます。

Webhookの呼び出し上限は、API呼び出し上限の80%に設定されます。
ビジネスプラスプランでは、選択した月間リンク作成上限に応じて利用可能なWebhook数が増加します。
エンタープライズプランは、利用規模に応じて個別にご相談のうえ提供します。
詳細な上限値はプラン別の呼び出し上限で確認できます。

リンクグループWebhookはエンタープライズ専用機能です。
リンクグループでWebhookを有効にすると、そのグループに含まれるすべてのリンクに自動的に適用されます。

上位プランへ変更すると、Webhookの利用上限はすぐに拡張されます。
下位プランへ変更し、新しい上限を超える対象がある場合は、古い対象から順に自動的に無効化されます。無効化された対象一覧はメールで通知します。
利用期間終了後に無料プランへ変更された場合でも、Webhook設定は保持されます。再度有料プランを契約すると、追加設定なしで自動的に再開されます。