Webhooks
Subscribe to real-time event notifications from CRM Factory.
Register webhook endpoints to receive real-time notifications when CRM records are created, updated, or deleted.
Registering a Webhook
POST /api/v1/webhooks
Content-Type: application/json
{
"url": "https://your-app.com/webhooks/crm",
"events": [
"opportunity.created",
"opportunity.stage_changed",
"case.created",
"case.escalated",
"lead.converted"
],
"secret": "whsec_your_shared_secret"
}Event Format
Events follow the pattern entity.action:
| Entity | Actions |
|---|---|
opportunity | created, updated, deleted, stage_changed |
case | created, updated, deleted, escalated |
lead | created, updated, deleted, converted |
contact | created, updated, deleted |
account | created, updated, deleted |
Listing Webhooks
GET /api/v1/webhooksReturns all registered webhooks for the current organization.
Payload Verification
If you provide a secret when registering the webhook, CRM Factory will include an HMAC signature in the webhook headers that you can use to verify the payload authenticity.
Managing Webhooks
| Action | Endpoint |
|---|---|
| List webhooks | GET /api/v1/webhooks |
| Register webhook | POST /api/v1/webhooks |