Skip to content
Amplifier
Console

Production Checklist

Use this checklist before deploying an Amplifier Health integration to production.

Audio Quality

  • Tested recording setup with sample audio in the target environment; audio_quality.issues is empty in test runs
  • Production recording pipeline uses 16 kHz mono WAV or FLAC (recommended; API also accepts MP3, M4A, and 8 kHz minimum)
  • Single-speaker capture confirmed.
  • Microphone placement follows guidelines in Audio Requirements

Credential Management

  • X-Account-ID and X-API-Key are stored as environment variables or in a secrets manager — not in source code
  • Credentials are excluded from all logging pipelines
  • Access to credentials is restricted to the services that need them

Error Handling

  • 401 (authentication failure) surfaces an alert to the integration team
  • 402 (no credits) surfaces a clear message and triggers a support notification
  • 400 / 422 errors (AUDIO_TOO_SHORT, AUDIO_TOO_LONG, UNSUPPORTED_FORMAT, AUDIO_POOR_QUALITY) return a user-facing prompt to re-record or correct the request
  • 429 (rate limit) handled with exponential backoff; Retry-After header is read
  • 500 errors retried with exponential backoff (max 5 retries)
  • See Error Reference for the complete error code list and retry guidance

Display Rules

  • score values are not displayed to patients or end users
  • summary.description is not surfaced in automated alerts or patient-facing output — shown only after review by qualified care staff
  • level and label are used as the display primitives in user-facing views
  • flagged: true is used to filter which signals appear in user-facing views
  • Display labels follow the recommended mapping in Levels & Actions

Analysis Selection

  • If using the Model API, the model_name matches the health context for your user population
  • If using the Sign API, the sign_name targets the specific signal relevant to your workflow
  • If your model or sign includes Emerging or Investigational signals, appropriate clinical oversight is in place
  • Your team understands how per-signal evidence tiers relate to your workflows (see Models and Model API)

Compliance

  • Data handling and retention requirements reviewed with your legal and compliance team
  • For wellness: individual employee results have appropriate privacy controls; aggregated team-level signals (not individual scores) are used for dashboards and manager views

Webhooks (if applicable)

Use webhooks to receive results via push instead of polling — useful when audio is submitted from a client device and results need to be delivered to a separate backend service, or when you want a persistent delivery mechanism for audit logging.

  • Webhook URL is HTTPS
  • Signature verification is implemented before processing any webhook payload — see Account
  • Idempotency check on job_id is implemented to handle webhook retries
  • Webhook receiver responds within 30 seconds to avoid delivery timeout

Final Verification

  • End-to-end test completed with a real recording in the target environment
  • audio_quality.issues verified as empty in the production environment test
  • escalate workflow tested with a simulated high-signal result
  • consider workflow tested to verify signals are surfaced and routed appropriately
  • recommended_action of none or inconclusive cases handled gracefully (no alert, log only)