Receive a comment update

{
  "eventId": "a12f0ac0-7fe9-4a1e-8c0b-2989913df12b",
  "eventType": "incident.comment.added",
  "deliveryId": "d3b81f02-12cd-49e3-8a55-7b1ba2f6e3a0",
  "correlationId": "b7e2f9a0-1c3d-4e5f-8a6b-9c0d1e2f3a4b",
  "cadIncidentId": "CAD-12345",
  "occurredAt": "2026-08-28T20:14:55.123Z",
  "data": {
    "text": "Patient is conscious and breathing.",
    "author": "GovWorx"
  }
}

{
  "ok": true,
  "deliveryId": "d2a78d0c-3f1a-4b32-9bd5-1a1f7e5a3c10"
}

{
  "code": "invalid_delivery",
  "message": "The webhook delivery is malformed."
}

{
  "code": "unauthorized",
  "message": "The webhook delivery could not be authenticated."
}

{
  "code": "delivery_id_reused",
  "message": "The delivery ID was reused with a different request body."
}

{
  "code": "rate_limited",
  "message": "The recipient is temporarily rate limited."
}

{
  "code": "temporarily_unavailable",
  "message": "The CAD endpoint is temporarily unable to process the delivery."
}

WEBHOOK

comment

{
  "eventId": "a12f0ac0-7fe9-4a1e-8c0b-2989913df12b",
  "eventType": "incident.comment.added",
  "deliveryId": "d3b81f02-12cd-49e3-8a55-7b1ba2f6e3a0",
  "correlationId": "b7e2f9a0-1c3d-4e5f-8a6b-9c0d1e2f3a4b",
  "cadIncidentId": "CAD-12345",
  "occurredAt": "2026-08-28T20:14:55.123Z",
  "data": {
    "text": "Patient is conscious and breathing.",
    "author": "GovWorx"
  }
}

{
  "ok": true,
  "deliveryId": "d2a78d0c-3f1a-4b32-9bd5-1a1f7e5a3c10"
}

{
  "code": "invalid_delivery",
  "message": "The webhook delivery is malformed."
}

{
  "code": "unauthorized",
  "message": "The webhook delivery could not be authenticated."
}

{
  "code": "delivery_id_reused",
  "message": "The delivery ID was reused with a different request body."
}

{
  "code": "rate_limited",
  "message": "The recipient is temporarily rate limited."
}

{
  "code": "temporarily_unavailable",
  "message": "The CAD endpoint is temporarily unable to process the delivery."
}

Authorizations

Authorization

string

header

required

Static bearer credential supplied by the CAD endpoint owner during onboarding. It is required only when the provisioned connector security profile includes WebhookBearer.

X-GWX-Signature

string

header

required

HMAC-SHA-256 signature formatted as v1=<lowercase-hex-digest>. The digest is computed with the UTF-8 bytes of the registered shared secret over these exact bytes, without whitespace normalization or JSON reserialization:

<X-GWX-Timestamp>.<X-GWX-Delivery-Id>.<raw-request-body>

Recipients must compare digests in constant time and require the timestamp to be within 300 seconds of their current time before applying the selected reliability profile. durable_idempotent recipients also enforce the expiration conveyed by their connector profile and durably serialize the business action by delivery ID. bounded_deduplication recipients apply the retention bound declared by their connector profile. A repeated ID with a different body is rejected whenever the selected profile supports deduplication.

Headers

X-GWX-Delivery-Id

string<uuid>

required

Identifier for one logical delivery to one recipient. Durable retry is planned. The selected connector reliability profile determines whether this value is durably stored, retained in a bounded cache, or unavailable for safe deduplication. Every permitted retry uses this same value and exact raw request body with a fresh timestamp and signature.

X-GWX-Event

enum<string>

required

Must match the eventType value in the request body.

Available options:

incident.call_type.recommended,

incident.comment.added,

incident.dispatch.recommended,

incident.interaction.completed

X-GWX-Origin

enum<string>

required

catchup identifies a update produced before the CAD interaction was linked. live identifies a update produced during normal live flow.

Available options:

catchup,

live

X-GWX-Timestamp

integer<int64>

required

Unix time in whole seconds when this delivery attempt was signed. It is required by the baseline replay-protected HMAC profile. Each retry receives a fresh timestamp and signature. Compatibility profiles may override this requirement when the vendor cannot support it.

Body

application/json

Option 1
Option 2

eventId

string<uuid>

required

Identifier of the vendor-neutral business event.

eventType

string

required

Allowed value: "incident.comment.added"

deliveryId

string<uuid>

required

Must match X-GWX-Delivery-Id.

correlationId

string

required

Required before a CAD incident identifier is available.

Required string length: 1 - 100

occurredAt

string<date-time>

required

Time the update was produced.

data

object

required

Show child attributes

cadIncidentId

string | null

CAD-assigned target identifier when known.

Required string length: 1 - 200

Response

The CAD accepted the delivery. Under durable_idempotent or bounded_deduplication, a delivery ID still inside the profile's retention bound is acknowledged without repeating the business action.

boolean

required

deliveryId

string<uuid>

required

CAD integration

CAD API reference

Authorizations

Headers

Body

Response