Skip to main content

Receive incident updates from GovWorx

GovWorx sends updates to an HTTPS endpoint that the CAD system hosts. An update can add information to an existing record or carry data that has no CAD incident yet. GovWorx sends an update whenever it has relevant data for an authorized listener. When a customer has more than one authorized listener, GovWorx delivers the update to each one. The update may have a CAD incident identifier, a GovWorx correlation identifier, or both. Some update types can arrive before either association exists. Each listener receives and acknowledges its delivery independently. A slow, failed, or incompatible listener does not delay or suppress delivery to another listener. The endpoint acknowledges that it received a delivery. Receipt does not by itself mean the CAD applied the update. A connector profile identifies which updates and fields the CAD supports, and whether it can confirm application.

Update an existing CAD incident

Once CAD has an incident identifier, GovWorx can deliver information for that record. The initial update types are below.

Call type

A recommended call type, discipline, and priority.

Comment

Narrative information for the incident.

Dispatch recommendation

A recommended set of resources for the incident.

Completed interaction

Completion information and the interaction transcript.
GovWorx can also share broader incident changes when an integration supports them. The public contract for those changes defines their fields and application behavior.

Receive a delivery

1

Verify the delivery

Verify the configured credential and signature before parsing the body. See Authentication.
2

Check the delivery identifier

Recognize a retry before applying the same update again. See Reliability.
3

Queue or apply the update

Apply supported fields, or queue the delivery for CAD processing. The connector profile defines what the CAD can represent and confirm.
4

Acknowledge receipt

Return the configured acknowledgement. A successful acknowledgement confirms receipt unless the connector profile explicitly provides application confirmation.

Reference

The CAD API reference contains the delivery envelopes, headers, acknowledgements, and schemas.

Receive incident updates from GovWorx

Review the complete webhook contract while implementing the endpoint.