Webhooks

Receive real-time notifications when events occur in Syntrigen.

What are Webhooks?

Webhooks are HTTP callbacks that notify your application when events happen: - New candidate applied - Assessment completed - Document created - Team member added

Setting Up Webhooks

Step 1: Create Endpoint

Create an HTTPS endpoint on your server to receive events.

Step 2: Register Webhook

In Settings > Developer > Webhooks: 1. Click "Add Webhook" 2. Enter your endpoint URL 3. Select events to subscribe 4. Save

Step 3: Verify Setup

We'll send a verification request to confirm your endpoint.

Event Payload

{
  "id": "evt_123456",
  "type": "candidate.applied",
  "created": "2024-12-01T10:30:00Z",
  "data": {
    "candidate_id": "cand_789",
    "job_id": "job_456",
    "source": "linkedin"
  }
}

Security

Signature Verification

Verify webhook authenticity using the signature header:

const crypto = require('crypto');
function verifySignature(payload, signature, secret) {
  const expected = crypto
    .createHmac('sha256', secret)
    .update(payload)
    .digest('hex');
  return signature === expected;
}

Best Practices

- Always verify signatures - Respond with 200 quickly - Process asynchronously - Handle retries idempotently