Webhook functionality is currently available for Pro plans. Please contact [email protected] for details and available options.
Breezy webhooks allow you to receive real-time notifications when events occur in your Breezy account. Instead of polling the API for changes, webhooks push data to your server as events happen.
What's New
The Breezy webhook system has been upgraded with new capabilities:
- Self-Service Management - Create, update, and delete webhook endpoints via API
- Position Events - Receive notifications when positions are created, updated, or deleted
- Team Discussion Events - Get notified when team notes are posted, updated, or deleted
- Enhanced Security - HMAC-SHA256 signature verification on all webhook deliveries
- Delivery Stats - Track successful and failed deliveries per endpoint
Available Events
| Event | Description |
|---|---|
candidateAdded | A candidate enters the system |
candidateDeleted | A candidate is deleted |
candidateStatusUpdated | A candidate moves to a different stage |
companyPositionAdded | A new position is created |
companyPositionUpdated | A position is updated |
companyPositionDeleted | A position is deleted |
companyPositionStateUpdated | A position state changes (draft, published, etc.) |
companyNotePosted | A team discussion note is posted |
companyNoteUpdated | A team discussion note is updated |
companyNoteDeleted | A team discussion note is deleted |
Quick Start
1. Create a Webhook Endpoint
curl -X POST https://api.breezy.hr/v3/company/{company_id}/webhook_endpoints \
-H "Authorization: {your_api_token}" \
-H "Content-Type: application/json" \
-d '{
"url": "https://your-server.com/webhook",
"description": "My webhook endpoint",
"events": ["candidateAdded", "candidateStatusUpdated"]
}'2. Save the Shared Secret
The response includes a secret field. Save this securely - you'll need it to verify webhook signatures.
3. Verify Incoming Webhooks
Use the shared secret to verify the X-Hook-Signature header on incoming requests. See Webhook Security for implementation details.
Documentation
- Webhook Events - All event types and payload structures
- Webhook Management API - Create, update, and delete endpoints
- Webhook Security - Signature verification and security best practices
- Customer Guide - Getting started for customers
- Partner Guide - Integration guide for partners
Limits
- 10 endpoints per customer
- 10 endpoints per partner (separate quota)
- HTTPS required for all webhook URLs
- 30 second timeout per delivery attempt
- 10 retry attempts with exponential backoff for failed deliveries
Support
Questions, problems, and feedback should be sent to [email protected].