Webhook

Webhook は、PeekHire で何かが起きるたびに、あなたが管理する URL に小さなメッセージをプッシュします — API をポーリングする代わりに、リアルタイムで対応できます。

Webhook の仕組み

1. 開発者ツール → Webhook で エンドポイント（あなたのサーバー上の URL、または自動化ツール）を作成します。
2. 受信する イベント を選択します。
3. イベントが発生すると、PeekHire は JSON ペイロードを含む HTTP POST を あなたのエンドポイントに送信します。

ペイロードは意図的に小さくしてあります — 何が起きたか、どのオブジェクトに関するものかを識別するためのものです。 必要であれば、REST API から詳細情報を取得できます。

利用できるイベント

イベントは、採用ライフサイクル全体をカバーしています。例:

• 応募 — application.submitted, application.updated, application.stage_changed, application.rated, application.archived, application.restored, application.deleted.
• 応募コメント — application.comment.created, application.comment.updated, application.comment.deleted.
• キャンペーン — campaign.created, campaign.activated, campaign.paused, campaign.archived, campaign.restored.

配信の検証

各配信には署名が付与されているため、本当に PeekHire から送信されたものかを確認できます。ペイロードを信頼する前にエンドポイントで署名を検証し、受信確認として 2xx ステータスを返してください。

配信の確認

配信 ビューでは、最近の Webhook 試行とその結果を確認できます。これにより、イベントが届いているかを確認したり、応答しないエンドポイントをデバッグしたりできます。

ヒント

• すばやく 2xx を返し、重い処理は非同期で実行しましょう。
• ハンドラーを 冪等 にしましょう — 同じイベントがまれに複数回配信されることがあります。
• サーバーを運用したくない場合は、Make、Zapier、n8n などのツールから始めましょう。