Roleplay CAD Webhooks & API Guide
Learn how to use webhooks and APIs to integrate your roleplay CAD with Discord, FiveM scripts, and external services. Complete guide to CAD API and webhook configuration.
A CAD system that operates in isolation misses enormous opportunities for automation and enhanced functionality. Webhooks and APIs transform your roleplay CAD from a standalone application into the central hub of your server's ecosystem, connecting dispatch operations to Discord notifications, FiveM game scripts, external databases, and custom applications. CDE CAD provides comprehensive webhook and API support that allows server developers to build powerful integrations tailored to their community's specific needs.
Discord Webhook Integration
Discord is the communication backbone of virtually every FiveM community, making Discord webhook integration one of the most valuable CAD features. CDE CAD can send automated notifications to designated Discord channels whenever significant events occur in the CAD system. When a 911 call is received, the details are posted to your dispatch channel automatically. When an officer goes on or off duty, the status change appears in your duty log channel. When an arrest is made or a report is filed, the relevant information flows to the appropriate Discord channel without any manual intervention.
Configuring Discord webhooks in CDE CAD is straightforward. Administrators create webhook URLs in their Discord server settings, then paste those URLs into the corresponding webhook configuration fields in the CAD admin panel. Each event type can be routed to a different channel, allowing communities to organize their Discord feeds by department, event type, or priority level. The webhook payloads include rich embed formatting with color-coded borders, structured fields, and clickable links back to the relevant CAD records.
Advanced webhook configurations support conditional triggers, meaning you can set up webhooks that only fire under specific conditions. For example, you might want a notification in a command staff channel only when a felony arrest is made, or an alert in a specific department channel only when calls in their jurisdiction are dispatched. This filtering ensures that Discord channels receive relevant information without noise from unrelated events.
REST API for Custom Integrations
Data Queries
Query person records, vehicle registrations, warrants, and call history programmatically for use in custom scripts and applications.
Event Triggers
Receive real-time event notifications via webhooks for 911 calls, status changes, arrests, and other CAD activities.
Action Endpoints
Create calls, update unit status, file reports, and manage records through API endpoints from your FiveM scripts.
Scoped Permissions
Generate API keys with granular permission scopes to control exactly what each integration can access and modify.
FiveM Script Integration
The most impactful CAD API integrations connect directly to FiveM game scripts, creating a seamless bridge between in-game actions and CAD operations. When an officer performs a traffic stop in-game, the MDT script can automatically query the CAD API with the vehicle's plate number, returning registration status, owner information, and any associated flags directly to the officer's in-game interface. This eliminates the need to alt-tab to a browser and manually type in plate numbers.
FiveM CAD webhooks can also flow in the opposite direction. In-game events can trigger CAD updates through the API. When a player dials 911 using an in-game phone script, the call details are automatically submitted to the CAD dispatch queue. When an officer arrives on scene, their unit status updates in the CAD automatically based on their proximity to the call location. These bidirectional integrations create a cohesive experience where the game world and the CAD system operate as a unified platform.
CDE CAD provides integration documentation and example scripts that help server developers get started quickly. The most common integration patterns, including plate lookups, 911 call submission, unit status sync, and panic button alerts, are covered with working code examples that can be adapted to any FiveM framework. Communities using popular frameworks like ESX or QBCore will find pre-built integration modules that work with minimal configuration.
Automation and Workflow Triggers
Beyond simple notifications, webhooks enable powerful automation workflows that reduce manual work and improve operational efficiency. For example, when a warrant is issued through the CAD, a webhook can automatically post the warrant details to a BOLO channel, update a community-wide wanted list, and trigger an in-game notification for all on-duty officers. When a civilian registers a new vehicle, the registration can be automatically verified and logged without dispatcher intervention.
CDE CAD's webhook system supports chaining, where the output of one webhook can trigger additional actions through external automation platforms. Server administrators who use tools like n8n or custom middleware can build complex automation chains that connect CAD events to practically any external service. This extensibility ensures that CDE CAD can adapt to any community's unique operational requirements without requiring changes to the core platform.
"Webhooks and API access transformed our CAD from a standalone tool into the nervous system of our entire server. Every department, every script, and every Discord channel is connected through CDE CAD's integration layer."
Monitoring and Troubleshooting
CDE CAD includes comprehensive logging for all webhook deliveries and API requests, making it easy to monitor integration health and troubleshoot issues. Administrators can view delivery history, inspect request and response payloads, and identify failed deliveries with detailed error messages. The system automatically retries failed webhook deliveries with exponential backoff, ensuring that temporary network issues do not result in lost notifications.
API usage dashboards show request volumes, response times, and error rates across all configured integrations. This visibility helps administrators identify performance bottlenecks, detect unauthorized access attempts, and optimize their integration configurations for maximum reliability. With these monitoring tools, maintaining a complex integration ecosystem becomes manageable even for communities without dedicated development staff.
Connect Your Entire Server Ecosystem
CDE CAD's webhooks and API make your CAD the central hub for all server operations.