Overview
Webhooks allow you to connect Corvid to third-party platforms, internal tools, or custom systems. When a specific event occurs in Corvid (such as a hotlist match or an alarm being triggered), a webhook sends an HTTP POST request with the event data to a URL of your choice — in real time.
Supported Event Types
• Hotlist Match — A detected plate matched an entry in one of your hotlists.
• Alarm Triggered — A new alarm was created.
• Camera Status Change — A camera went online or offline.
• LPR Event — A license plate was detected (configurable by site or camera).
Common Use Cases
• Sending hotlist match notifications to a Slack channel or external alerting system.
• Triggering a gate or barrier to open when a specific plate is detected.
• Logging Corvid events into a SIEM or security analytics platform.
• Integrating Corvid alerts into a custom internal dashboard.
Webhook Payload
Each webhook request includes:
• Event type and timestamp.
• Organization and site identifiers.
• Event-specific data (e.g., license plate, camera ID, alarm details).
• A signature header for payload verification.
How to Use It
1. Navigate to Webhooks from the sidebar.
2. Click New Webhook and enter your endpoint URL.
3. Select the event types you want to receive.
4. Save the webhook. Corvid will immediately begin sending events to your endpoint.
5. Use the delivery logs to verify that events are being received correctly.
6. Rotate or revoke the webhook secret at any time from the settings panel.