Skip to main content

Integration Checklist

Once you've talked with your Prepared CSM and have identified what APIs your integration requires, use this checklist to ensure you've covered all the necessary steps.

Prerequisites​

  • Contact your Prepared CSM (customer success manager) to identify integration requirements
  • Determine which scope you need (cad_incidents or incident_events)
  • Provide Prepared with a list of ECCs that will be integrated

Authentication Setup​

  • Receive OAuth Credentials from Prepared (per ECC)
    • client_id
    • client_secret
    • scope
  • Implement OAuth token retrieval (see Authentication)
  • Implement token refresh before expiration

CAD Incidents Integration (cad_incidents scope)​

Incident Events Integration (incident_events scope)​

Webhook Integration​

  • Provide webhook URL to Prepared
  • Establish with Prepared the webhook authentication method (long-lived token in Auth header, or OAuth client_id + client_secret)
  • Implement webhook handlers for your scope:

CAD Webhooks (cad_incidents scope)​

  • note_created — Prepared note added to incident
  • location_updated — Caller location updated

Incident Events Webhooks (incident_events scope)​

  • incident_metadata — Incident created/updated
  • caller_location — Caller location updated
  • media — Media attached to incident

Testing​

  • Test in Prepared sandbox environment
  • Verify token refresh works correctly
  • Test webhook delivery and handling
  • Coordinate production deployment with Prepared team