Skip to main content

CAD Connector - ARMS API

GovWorx is able to connect to the ARMS API to ingest CAD incident records.

Written by Billy Keen

Overview

The data agent connects directly to the ARMS API. The GovWorx Data Agent checks ARMS on a regular schedule and brings over recent incidents, including unit activity and CAD notes.

The Data Agent waits until an incident is actually finished before sending it, so your team sees the complete record rather than a partial one. An incident is considered finished when it has a disposition, has a final call type, or all assigned units have cleared.

If an incident stays open for an unusually long time, the Data Agent sends it anyway after a few hours so nothing gets left behind. Each incident is sent once — you won't see duplicates in GovWorx.

The connector offers the following configuration parameters.

*: Required

Configuration

Explanation

Base URL*

The base API URL. Endpoint URLs are constructed using this.

API Access Token*

Your agency's ARMS access token. Stored securely and never displayed

Page Size

How many incidents are requested at a time. Default is 100.

Initial Lookback (Hours)

How far back to reach when the connection is first enabled. Default is 24 hours.

Settle Deadline (Hours)

how long to wait on a still-open incident before sending it anyway. Default is 4 hours.

What Comes Across

For each closed incident:

- Incident number, case number, and date/time

- Initial and final call type, priority, and disposition

- How the call came in

- Address or place name, plus map coordinates

- Agency and response area

- Each unit's dispatched, en route, arrived, and cleared times

- CAD notes with their timestamps

Authentication

The Data Agent authenticates to ARMS with a static API key issued by ARMS, sent in the X-ApiKey request header. The key is stored encrypted in the Data Agent's local configuration and is never written to logs.

Endpoint usage

The Data Agent makes read-only GET requests exclusively. It reads the incident list, incident detail, incident units, and incident notes endpoints. It never calls any endpoint that creates, modifies, or deletes ARMS data.

Did this answer your question?