Webhooks¶
Webhooks enable real-time integration with external systems by sending HTTP notifications when events occur in Enjade.
Overview¶
When configured events happen (e.g., an element is created or a cost plan is updated), Enjade sends a POST request to your specified URL with event details.
Setting Up a Webhook¶
- Navigate to Webhooks in the admin sidebar
- Click Create
- Configure the webhook:
- Name - A descriptive label
- URL - The endpoint that will receive notifications
- Events - Select which events trigger the webhook
- Secret (optional) - A shared secret for verifying webhook signatures
- Active - Enable or disable the webhook
Supported Events¶
| Event | Description |
|---|---|
element.created |
A new element was created |
element.updated |
An element was modified |
element.deleted |
An element was deleted |
bim_model.conversion.completed |
BIM model conversion finished |
bim_model.conversion.failed |
BIM model conversion failed |
cost_plan.updated |
A cost plan was modified |
Webhook Payload¶
Each webhook delivery includes:
- Event type - The event that triggered the notification
- Timestamp - When the event occurred
- Data - The relevant entity data
- Signature - HMAC signature (if a secret is configured)
Managing Webhooks¶
From the webhooks list, you can:
- Edit - Update URL, events, or secret
- Activate/Deactivate - Toggle webhook delivery
- Delete - Remove the webhook configuration
Security¶
- Use HTTPS URLs for webhook endpoints
- Configure a secret to verify webhook authenticity
- Webhook signatures are sent in the request headers for validation
Permissions¶
Managing webhooks requires admin access to the project.