Skip to main content

CAD Webhooks

Required scope: cad_incidents

When events occur for linked CAD incidents, Prepared sends webhook payloads to your configured endpoint. All events are sent as HTTP POST requests with a JSON body.

Event Types

Prepared sends the following event types to CAD integrations:

Event TypeDescription
note_createdA note was added to the incident (AI summary, media link, etc.)
location_updatedThe caller's location was updated

Common Fields

All webhook payloads include these fields:

FieldTypeDescription
event_typestringThe type of event (note_created, location_updated)
incident_iduuidPrepared incident ID
cad_partner_incident_idstringYour CAD incident ID (as provided when creating the incident)
created_atdatetimeWhen the event occurred

note_created

Sent when Prepared adds a note to the incident. Notes include AI summaries, media links, and incident URLs.

Payload Schema

FieldTypeRequiredDescription
iduuidUnique identifier for this note
incident_iduuidPrepared incident ID
cad_partner_incident_idstringYour CAD incident ID
created_atdatetimeWhen the note was created
event_typestringAlways "note_created"
subtypestringType of note (see below)
notestringThe note content
metadataobjectAdditional data specific to the note type

Note Subtypes

SubtypeDescription
media_linkURL to a media file (audio recording, photo, video)
insight_summaryAI-generated summary of the call
incident_linkURL to the Prepared chatroom
responder_linkURL to Prepared's OnScene chatroom

Example Payload

{
"id": "550e8400-e29b-41d4-a716-446655440000",
"incident_id": "550e8400-e29b-41d4-a716-446655440001",
"cad_partner_incident_id": "550e8400-e29b-41d4-a716-446655440002",
"created_at": "2024-01-15 10:30:00 UTC",
"event_type": "note_created",
"subtype": "insight_summary",
"note": "Caller reports a vehicle accident at the intersection. Two vehicles involved, no injuries reported. Caller is waiting at the scene.",
"metadata": {
"confidence": 0.95
}
}

location_updated

Sent when Prepared receives an updated location for the caller.

Payload Schema

FieldTypeRequiredDescription
iduuidUnique identifier for this location update
incident_iduuidPrepared incident ID
cad_partner_incident_idstringYour CAD incident ID
created_atdatetimeWhen the location was captured
event_typestringAlways "location_updated"
typestringLocation type (currently only "caller")
latitudenumberLatitude coordinate
longitudenumberLongitude coordinate
sourcestringSource of the location data

Location Sources

SourceDescription
preparedPrepared livestream link
rapid_sosRapidSOS location service
indigitalIndigital location service
ani_aliTraditional 911 ANI/ALI

Example Payload

{
"id": "550e8400-e29b-41d4-a716-446655440003",
"incident_id": "550e8400-e29b-41d4-a716-446655440001",
"cad_partner_incident_id": "550e8400-e29b-41d4-a716-446655440002",
"created_at": "2024-01-15 10:30:15 UTC",
"event_type": "location_updated",
"type": "caller",
"latitude": 37.7749,
"longitude": -122.4194,
"source": "prepared"
}

Handling Webhooks

Your webhook endpoint should:

  1. Validate the authentication using the method you agreed with Prepared (e.g. Bearer token in Authorization header)
  2. Return 200 immediately to acknowledge receipt
  3. Process the event asynchronously