テストと管理

すべての操作は開発者 → Webhookにあります。Webhook は 1 件につき 1 行で、ステータス、フィルター、最後に配信した時刻が表示されます。

開発者ページの API キーと Webhook

できることは、ロールによって異なります。

• 組織の管理者とマネージャーは、追加、編集、一時停止、削除、再発行、再配信ができます。それ以外のメンバーには「Webhook を管理できるのは組織の管理者とマネージャーのみです。」と表示されます。
• 1 組織につき Webhook は 5 件までです。上限に達すると、ページに「Webhook は 5 件まで登録できます。追加するには 1 件削除してください。」と表示されます。
• 行には有効、一時停止中、無効のいずれかが表示されます。

行メニュー

行の Webhook の操作をクリックします。

Webhook の行メニュー

無効の Webhook には、バナーに再度有効にするが表示されます。再開と同様に止まった位置から続け、さらに停止した配信をもう一度キューに入れます。再試行と失敗をご覧ください。

フィルターを編集する

変更は、変更後に送られる実行に適用されます。送信済みの実行の POST の件数は変わりませんが、そのページには現在のフィルターが適用されます。編集後は、ページの total やイベントが POST の件数と異なることがあります。フィルターからプロジェクトを外すと、そのプロジェクトの実行は送られなくなります。フィルター内のプロジェクトが削除されている場合、行に削除されたプロジェクトのピルが表示され、そのエントリは何にも一致しません。

配信履歴シート

配信履歴を見るは、配信履歴を新しい順に一覧表示します。1 行が 1 回の POST、つまり 1 つの Webhook への 1 つの実行です。保持期間は 30 日間です。

配信履歴シート

各行には次の内容が表示されます。

ボタン: 失敗した行の再送（同じ配信を同じ webhookId でもう一度送ります）、停止した行の再配信（新しい webhookId の新しい配信として送ります）、上部の停止した配信を再配信（停止した配信すべて。失敗した配信は対象外）、さらに読み込む。フッターには「M 件中 N 件を表示中」と表示されます。M は Webhook のすべての配信の数です。合計がわからないときは「N 件を表示中」と表示されます。履歴が空のときは「配信はまだありません。テストイベントを送信するとここに表示されます。」と表示されます。

再送と再配信には有効な Webhook が必要です。有効でない場合は「この Webhook は有効ではありません。先に再開してください。」と表示されます。再配信をご覧ください。

メッセージ

URL の検証

ダイアログは、入力中に URL をチェックします。

サーバーメッセージ

公開 Webhook 管理 API

アプリを使わずに Webhook を管理できます。認証には同じ API キーを使い、x-api-key ヘッダーで送ります。テストイベントを送信、シークレットを再発行、配信履歴はアプリ専用です。

filters には 5 つのリストがあります。eventTypes、subEventTypes、actions（new、updated、removed）、domains（小文字の競合ドメイン）、projectIds です。空のリスト、またはリストがない場合は、すべてに一致します。

PATCH の resume は、次の 2 つの値のどちらかです。

再配信のボディで、もう一度キューに入れる配信を選びます。キーはすべて省略可能で、送ったキーは AND で組み合わされます。

空のボディ {} は、停止したすべての配信を再配信します。テスト配信は再配信されません。1 回の呼び出しで再配信するのは古い順に最大 500 件です。replayed が 0 になるまで呼び出してください。レスポンスは { "replayed": n } です。

再配信は、新しい webhookId と新しいページトークンを持つ新しい配信です。元の行は再配信済みになります。

SIGNALS_HOST には、サインインするアプリのアドレスを設定します。開発者ページの試してみるのコマンドに表示されます。

1curl -X POST $SIGNALS_HOST/api/public/v1/webhooks \
2  -H "x-api-key: $SIGNALS_API_KEY" \
3  -H "Content-Type: application/json" \
4  -d '{
5    "url": "https://your-app.com/signals-hook",
6    "filters": { "eventTypes": ["jobs"], "subEventTypes": [], "actions": ["removed"], "domains": ["hubspot.com"] }
7  }'

1curl -X POST $SIGNALS_HOST/api/public/v1/webhooks/$WEBHOOK_ID/replay \
2  -H "x-api-key: $SIGNALS_API_KEY" \
3  -H "Content-Type: application/json" \
4  -d '{ "status": "dead" }'

API のエラーは { "error": "..." } の形式です。機械可読な完全な仕様は /api/public/docsにあります。