前提条件
- モニターアクセス権のあるPubrio APIキー
- パブリックにアクセス可能なHTTPSエンドポイント(またはusewebhook.comのテストURL)
ステップ1:ウェブフック配信先でモニターを作成
headers オブジェクトは毎回の配信にカスタムHTTPヘッダーを追加します(認証に便利)。body オブジェクトはウェブフックペイロードのルートレベルにカスタムフィールドを追加します。
ステップ2:ウェブフック接続を検証
ウェブフック検証エンドポイントを使用してエンドポイントが到達可能かテストします。これはプレースホルダーデータを含むサンプルペイロードを送信します — クレジットは消費されず、実際のシグナルは取得されません。ステップ3:実データでテスト
接続が検証されたら、プロセストライエンドポイントを使用して実際の実行をトリガーします。これは実際のシグナルを取得しウェブフックに配信します —tried_at に最近の過去の日付を使用してデータが利用可能であることを確認してください:
validateと異なり、tryエンドポイントは実際のスキャンを実行しクレジットを消費します。実際のペイロードが正しく届くことを確認し、スケジュールされたスキャンが開始される前に結果をすばやく推定するために使用してください。
ステップ4:シグネチャの検証
各モニターには、受信ペイロードがPubrioからのものであることを確認するための一意のシグネチャがあります。monitor.monitor_id と比較して真正性を検証します。
ウェブフックペイロード構造
ペイロードはモニターのdetection_mode に応じて異なります:
- シグナルファースト
- カンパニーファースト
signal_first モードでは、ペイロードにトップレベルの signals 配列が含まれます:destination_config のカスタム body フィールドはルートレベルに表示されます(例:上記の例の "pipeline": "my-webhook")。メール配信先
メール配信を希望するチームは、destination_type を "email" に設定してください:
Pubrioはエージェンシーやチーム向けのホワイトラベルメール配信をサポートしています。送信者ドメインとブランディングのカスタマイズについてはお問い合わせください。
トラブルシューティング
ウェブフックがペイロードを受信しない
ウェブフックがペイロードを受信しない
障害後にモニターが一時停止
障害後にモニターが一時停止
ウェブフックが一貫して非200コードを返す場合、
max_failure_trigger の連続失敗回数に達するとモニターが一時停止します。問題を修正し、モニター更新で再アクティベートしてください。重複ペイロード
重複ペイロード
配信に失敗しリトライが設定されている場合、同じペイロードを複数回受信する可能性があります。
triggered_at またはログIDを使用して重複排除してください。ペイロードが大きすぎる
ペイロードが大きすぎる
max_records_per_trigger を減らして配信ごとのレコード数を制限してください。フィルターを絞り込んでマッチするシグナル量を減らすこともできます。
