Skip to main content
POST
/
realtime
/
v1
/
cad
/
incident
Link Incident
curl --request POST \
  --url https://realtime.govworx.net/realtime/v1/cad/incident \
  --header 'Content-Type: application/json' \
  --data '
{
  "incidentId": "<string>",
  "userId": "<string>",
  "fields": [
    {
      "name": "<string>",
      "value": "<string>",
      "cad_field_name": "<string>"
    }
  ]
}
'
{
  "incidentId": "<string>",
  "callId": "<string>",
  "assistCallUrl": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developers.govworx.ai/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

Request to link a CAD incident to an Assist call.

​
incidentId
string

Unique ID for the incident in the source CAD.

​
userId
string

Unique ID / Personnel ID / Agent ID for the CAD user that owns the incident.

​
fields
object[]

CAD systems can send additional metadata about the call.

All fields are optional, but may impact Assist functionality depending on how Assist is configured.

Assist recognizes the following fields, which the CAD system must map to:

INCIDENT_TYPE - The type of Incident, Incident Code, or Chief Complaint. Typically a code or short-hand value, like ABVEH (Abandoned Vehicle). If the CAD sends this value, and it matches an Assist Guide Card, then Assist will pre-populate the Guide Card instead of attempting to detect the most relevant Guide Card on its own.

INCIDENT_DESCRIPTION - Description of Incident as entered by Call Taker. If no INCIDENT_TYPE is provided, this may be used by Assist to select an initial Guide Card.

INCIDENT_LOCATION - Street address or other human readable string describing location of the Incident.

CALLER_LATITUDE - Decimal degrees for latitude of caller's location. Example: 32.114

CALLER_LONGITUDE - Decimal degrees for longitude of caller's location. Example: -81.211

CALLER_PHONE - Caller's phone number.

CALLER_NAME - Name of caller.

CAD systems may send additional metadata, but only the items in the above list have special meaning in Assist.

Response

OK

Response to link a CAD incident to an Assist call. Provides identifiers for correlation between systems.

​
incidentId
string

Unique ID for the incident in the source CAD.

​
callId
string

Unique ID for active call in Assist.

​
assistCallUrl
string

URL that when opened in a browser will show the call in Assist.