PulseCAD API¶
The PulseCAD API lets your own server, Discord bot or website read and write your community's CAD data: who is on duty, members and their department roles, calls and the 911 queue, civilians and their property, BOLOs, warrants, reports, the court, 511 road events, CAD messages, duty hours and your Insights. Webhooks push events to your server as they happen.
The API cannot change a unit's status or location, trigger a panic, assign units or answer 911s. Your game resource and your dispatchers do that.
The API is included with Pulse Max and Pulse Max ER:LC.
Keys are passwords
Use your key only from a server you control. Never put it in a web page, a Discord message, a public repository or a game client. Requests sent from a web browser are refused.
Getting a key¶
Only the community owner can create keys. Open Admin → Integrations → API & webhooks.
- Read the API terms, tick I have read the PulseCAD API terms, and click Accept and continue (once per community). Until the owner does this, no key or webhook can be created, and the API, webhooks and FiveM script sync are off for the community.
- Click Create key. Pick a preset that matches what you are connecting (Website dashboard, Discord bot, Member and role sync, Character sync, Evidence uploader, Records lookup, Judge or court bot, Alarms and 911 feed, DMV, DOT and 511, Report writer) or tick the scopes yourself. A preset only fills in the boxes, so you can change anything before saving. The search box finds a scope by name or description.
- Optionally limit the key to your server's IP address, and set how long it lasts with the slider (1 to 365 days).
- Copy the key from the box that appears. You will not see it again.
When a key is close to expiring, or has expired, click Renew on it and pick a new length. The key and its secret stay the same, so nothing on your side changes. A revoked key, or one replaced by Rotate, cannot be renewed.
A community can have up to 10 active keys. Each key works for your community only.
Scopes¶
| Scope | What it allows |
|---|---|
community:read |
Community name, platform, plan and game servers. |
departments:read |
Departments and their roles with rank. |
members:read |
Members: name, access level, status, department roles, rank, Discord and Roblox ids. Never emails. |
members:write |
Change a member's department roles, nickname and status. High risk. |
members:admin |
Change a member between admin and member, and remove members. High risk. |
shifts:read |
Duty history and hours. |
units:read |
Units on duty and dispatchers in service. |
calls:read |
Calls, with shared notes only. |
civilians:read |
Civilian lookups without sensitive fields. |
civilians:sensitive |
Adds SSN, medical profile, phone, address and emergency contact. High risk. |
civilians:write |
Create, update and remove civilians the API created. |
vehicles:write |
Register and update vehicles. |
licenses:write |
Issue and renew licences. |
firearms:write |
Register firearms. |
reference:read |
Penal code, call types, status codes and pre-arrival protocols. |
reports:read |
Reports: approved and served ones in full (narrative, charges, location); drafts and pending ones as a header only. |
reports:write |
Write draft reports for a member, who reviews and files them in the CAD. |
calls:write |
Create calls and add notes to them. Never assigns units. |
emergency:read |
The 911 queue: waiting and answered 911s with caller, location and messages. |
recordings:read |
911 call recordings: the list, transcripts and the audio. High risk. |
bolos:read, bolos:write |
Read BOLOs; issue, edit and clear them. |
warrants:read, warrants:write |
Read warrants; request them and mark a signed warrant active or served. |
warrants:judge |
Sign, deny, recall and expunge warrants. High risk. |
court:read |
Court cases, hearings, charges, verdicts and judgments. Never the case chat. |
court:write |
File civil cases on a plaintiff's behalf, as counsel. |
court:judge |
Schedule and run hearings, rule on charges, change a case's status, enter civil judgments. High risk. |
property:read, property:write |
Stolen property and impounds; enter and clear stolen property, release impounds, register boats. |
licenses:suspend |
Suspend, revoke and reinstate licences with a reason. High risk. |
roads:read, roads:write |
511 road events; post, update and clear them. |
messages:write |
Send CAD messages to members, a department, a callsign or a whole server. |
invites:write |
Create invites that let people join with department roles. Never admin. High risk. |
stats:read |
Your Insights: call volume, response times, reports, warrants. |
evidence:read |
List and download evidence on reports and court cases. |
evidence:write |
Attach links and upload files. High risk. |
bulk:write |
Bulk create or update, 100 items per request. High risk. |
Creating a key with a high-risk scope asks you to sign in again first. Click Sign in again on the page. For the next five minutes, in that browser, you can create, rotate or turn back on high-risk keys and manage webhooks.
Looking after your keys¶
Each key on the page has:
- Requests: every request it made in the last 30 days (time, request, result, address).
- Rotate: makes a new key with the same scopes. The old one keeps working for 24 hours so you can switch over.
- Revoke: stops it straight away. Revoke all keys stops every key at once.
The owner is emailed when a key is created, rotated, revoked or turned back on, when a key is used from a new address, when a key keeps getting refused, and when someone tries a revoked or expired key.
When the community changes owner, every key is paused and every webhook is switched off until the new owner checks them and turns them back on.
Making requests¶
The address is https://cad.mypulsetech.com/api/public/. Send your key in the Authorization header:
/me returns the key's name, scopes, community and plan. Call it first to check your key works.
Every endpoint and parameter is listed in cad.mypulsetech.com/api/public/openapi.json, which you can load into Postman, Insomnia or any OpenAPI tool.
What you can read¶
| Endpoint | Returns |
|---|---|
GET /community |
Name, platform, plan, game servers. |
GET /departments |
Departments, roles and ranks. |
GET /members |
Members. Add ?discordId=, ?robloxId= or ?license= to find one person. |
GET /units |
Units on duty: callsign, officer, department, rank, status, calls. A position only while the unit is in game. |
GET /dispatchers |
Dispatchers in service. |
GET /calls |
Open calls (or ?status=CLOSED or ALL), with shared notes only. ?address= lists past calls at an address. |
GET /shifts |
Duty history and total minutes per member and department, up to 90 days at a time. |
GET /civilians |
Find by your id, name and date of birth, owner, or SSN (SSN needs civilians:sensitive). |
GET /vehicles/plate/{plate} |
One vehicle. |
GET /penal-codes, /call-types, /status-codes, /prearrival-protocols |
Reference lists. |
GET /bolos, /warrants, /reports, /court/cases, /court/hearings |
Lists, each with a /{id} for one record (warrants and cases also by number). |
GET /emergencies |
The 911 queue for the last 7 days. Anonymous callers stay anonymous; dispatchers' internal notes are never included. |
GET /recordings, /recordings/{id}/audio |
911 recordings and their audio. |
GET /road-events, /impounds, /stats |
511 events, impounded vehicles, Insights. |
Lists come in pages of up to 100. Pass the next value back as ?cursor= for the next page.
Changing members¶
PATCH /members/{id} changes department roles (addDepartmentRoleIds, removeDepartmentRoleIds), nickname and status. Changing someone between admin and member, or changing anything about an admin, needs members:admin. The owner can never be changed through the API. Members synced from PulseRoster are managed in PulseRoster and answer 409 roster_managed.
Syncing characters, vehicles, licences and firearms¶
Use your own system's id for each character so the same character is never added twice:
curl -X PUT https://cad.mypulsetech.com/api/public/civilians/external/char-1042 \
-H "Authorization: Bearer pulsecad_sk_..." -H "Content-Type: application/json" \
-d '{ "first": "Riley", "last": "Doe", "dob": "1990-01-02", "sex": "F", "owner": { "discordId": "123456789012345678" } }'
Sending it again with the same id updates that person. The owner is linked only if they are a member of your community.
PUT /vehicles/plate/{plate}registers or updates a vehicle.ABC123andABC-123are the same car.PUT /civilians/external/{id}/licenses/DRIVERissues or renews a licence.PUT /firearms/serial/{serial}registers a firearm.POST /bulk/civiliansandPOST /bulk/vehiclestake up to 100 at once, for a first sync.
The API never lifts a suspended or revoked licence or a suspended registration. Those are penalties an officer or a court gave.
Dispatch: calls, BOLOs and messages¶
POST /callscreates a call the same as a new, undispatched one in the CAD: it arrives pending and unassigned, alerts dispatch (or pages stations when nobody is dispatching), and a department list spanning police, fire and tow opens one linked incident per service.POST /calls/{id}/notesadds a note (shared by default).POST /bolosissues a BOLO the same as one made in the CAD: the alert and tone for LEO and dispatch, and the Discord post.PATCH /bolos/{id}edits it andPOST /bolos/{id}/clearclears it.POST /messagessends a CAD message to members (by id or Discord id), a department, dispatch zone or callsign (people on duty right now), or the whole server.
BOLOs, calls, messages and road events belong to a game server. Pass server to pick one; otherwise your default server is used.
Reports, warrants and the court¶
POST /reportswrites a draft for a member (author: { discordId },memberId,robloxIdorlicense), with charges priced from your penal code. It lands in that officer's Records, where they review and file it. Fines, points, court cases and signature prompts happen when it is filed in the CAD.POST /warrantsrequests a warrant. It always waits for a judge.PATCH /warrants/{id}withstatusrules on it (SIGNED,DENIED,RECALLED,EXPUNGED, which needwarrants:judge) or executes a signed one (ACTIVE,SERVED).- With
court:judgea key can run the court:POST /court/cases/{id}/hearings,PATCH /court/hearings/{id},POST /court/charges/{id}/disposition,PATCH /court/cases/{id}and, for civil cases,POST /court/cases/{id}/judgment. Rulings follow the same rules as in the CAD: dismissing a case recalls its warrants, a not-guilty verdict takes back licence points, and a judgment is never more than was claimed. POST /court/civil-casesfiles a civil case as counsel; both parties are served.
Property, licences and 511¶
POST /stolen/{vehicle|firearm|boat}/{plate or serial or registration}with{ "stolen": true }enters it as stolen (every return says STOLEN and the plate reader lights up);{ "stolen": false }clears it.POST /vehicles/plate/{plate}/releasereleases an impounded vehicle.PUT /boats/{registration}registers or updates a boat.POST /licenses/{id}/actionsuspends, revokes or reinstates a licence. Suspending or revoking needs areason, which officers read on a return.POST /road-eventsposts a 511 event straight onto the board and the map;PATCH /road-events/{id}updates or clears it.POST /invitescreates an invite (permission key) that grants department roles, never admin, and returns a join link.
Evidence on reports and court cases¶
POST /reports/{id}/evidence (or /court/cases/{id}/evidence) attaches:
- a link, sent as JSON:
{ "url": "https://...", "title": "Dash cam" }. Links must start withhttps://. - a file, sent as
multipart/form-datawith the file in a field namedfile: JPEG, PNG, WebP or PDF up to 25 MB, MP4 up to 95 MB.
Photos lose their hidden metadata (including GPS) when stored. Videos are stored as uploaded, so remove anything you do not want kept before uploading. Each file gets a SHA-256 fingerprint, shown next to it in the CAD. Evidence appears under Attached Evidence on the report in the Records Console and under Exhibits on the court case, where officers and court staff can add their own. A key can remove only evidence the API added.
Evidence storage depends on the plan: 10 GB on Pulse Max and Pulse Max ER:LC, 5 GB on Pulse Pro, 1 GB on Pulse One and the free Pulse One ER:LC. A person can upload 50 files a day from the CAD, and an API key 500.
Webhooks¶
Webhooks send events to your server as they happen. Add one under Webhooks on the same admin page: enter an https:// address and pick the events. Adding a webhook or changing its address needs a recent sign-in, like a high-risk key.
| Event | When |
|---|---|
unit.on_duty, unit.off_duty, unit.status_changed |
A unit goes on or off duty, or changes status. |
call.created, call.updated, call.closed |
A call is created, changes, or is closed. |
member.joined, member.updated, member.left |
Someone joins, is changed, or leaves. |
civilian.created, civilian.updated |
A civilian is created or updated. |
evidence.added |
Evidence is attached to a report or court case. |
unit.panic |
A unit presses PANIC. |
emergency.received |
A 911 call comes in. |
bolo.created, bolo.updated, bolo.cleared |
A BOLO is issued, edited or cleared. |
warrant.created, warrant.status_changed |
A warrant is requested (or issued), or is signed, denied, made active, served, recalled or expunged. |
report.created, report.status_changed |
A report is written, or is filed, approved, kicked back, voided or served. |
court.case_updated |
A court case is filed or changes: hearings, rulings, verdicts, judgments. |
road.created, road.updated, road.cleared |
A 511 road event is posted, changes or is cleared. |
property.stolen, property.recovered |
Property is entered as stolen, or cleared. |
vehicle.impounded, vehicle.released |
A vehicle is impounded or released. |
Events fire for changes made in the CAD as well as through the API. The webhook page has presets: Dispatch feed, Officer activity, Records and court, Member sync, Character sync, and Traffic and property.
Each delivery is a POST with a JSON body { id, event, createdAt, communityId, data }, where data is the same shape the API returns for that record. Civilians never include sensitive fields.
Checking the signature¶
Every delivery carries X-PulseCAD-Signature: t=<unix time>,sig=<hex>. The sig is an HMAC-SHA256 of "<t>.<raw body>" using your webhook secret. Reject deliveries whose signature does not match or whose t is more than five minutes old:
const crypto = require('crypto');
function verify(rawBody, header, secret) {
const t = /t=(\d+)/.exec(header)?.[1];
if (!t || Math.abs(Date.now() / 1000 - Number(t)) > 300) return false;
const want = crypto.createHmac('sha256', secret).update(`${t}.${rawBody}`).digest('hex');
return header.split(',').some((p) => p === `sig=${want}`);
}
Use X-PulseCAD-Delivery to ignore a delivery you have already handled. While you rotate the secret, deliveries carry a signature from both the old and the new secret for 24 hours.
Answer with any 2xx status within five seconds. A failed delivery is retried after 1 minute, 5 minutes, 30 minutes, 2 hours and 12 hours. After 20 failures in a row the webhook is paused and the owner is emailed; fix your server, then click Turn on. Deliveries shows the last 7 days, and Send test event sends a test right away.
FiveM: script sync¶
FiveM servers can let their other scripts add civilians, vehicles, licences and firearms to the CAD without an API key: for example character creation in C7, QBCore or ESX, car dealers, the DMV and gun shops. Turn on Script sync under Admin → FiveM (Pulse Max), then call the exports from your server-side scripts:
exports.pulsecad:CreateCivilian(characterId, { first = 'Riley', last = 'Doe', dob = '1990-01-02', sex = 'F', source = playerId })
exports.pulsecad:UpdateCivilian(characterId, { address = '1420 Senora Rd' })
exports.pulsecad:RegisterVehicle(plate, { ownerExternalId = characterId, make = 'Vapid', model = 'Stanier' })
exports.pulsecad:IssueLicense(characterId, 'DRIVER', { status = 'VALID' })
exports.pulsecad:RegisterFirearm(serial, { ownerExternalId = characterId, make = 'Hawk' })
CreateCivilian creates the civilian, or updates it if that character id was synced before, so calling it twice never makes a duplicate. UpdateCivilian changes only the fields you pass and fails with not_found if the character was never created.
Each export also takes an optional callback function(ok, data). Passing source (the player's server id) makes that player the owner, if their account is a member of your community. To let only some resources call the exports, add to server.cfg:
The exports follow the same rules as the API, and every call is logged under the resource that made it.
Never pass player input straight through
Build the data you send from your own server-side records. If a script forwards a table that came from a player's game client, that player could choose the owner or the details of the record. Script sync needs pulsecad resource 2.19.0 or newer.
Limits and errors¶
Each key can make 120 reads, 30 writes and 10 uploads a minute, plus 1,000 bulk items. Every response has X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Over the limit you get 429 with Retry-After.
Errors look like this:
{ "error": { "code": "missing_scope", "message": "This API key does not have the members:write scope." } }
| Status | Meaning |
|---|---|
| 400 | Bad request (check issues for which field). |
| 401 | Missing, wrong, revoked or expired key. |
| 402 | The community is not on Pulse Max. |
| 403 | The key lacks the scope, is paused, or is used from an address it does not allow. |
| 404 | Not found. A record from another community answers the same way. |
| 409 | Not allowed in its current state (owner, roster-managed member, suspended licence). |
| 429 | Rate limited. |
Retries: send an Idempotency-Key header on writes. A retry with the same value within 24 hours returns the first answer instead of writing twice.
Versions: your key stays on the version it was made with, so changes on our side never break it. Every response names the version that answered in a PulseCAD-Version header.