ConverterHQDevelopers
Documentation

Production readiness checklist

A concrete checklist for moving a ConverterHQ integration from prototype to dependable production traffic.

Use this checklist before sending important customer workloads through a live key.

Credentials

  • Use a dedicated live key with minimum required scopes.
  • Keep permanent API keys server-side.
  • Use signed URLs or delegated OAuth for browser/third-party access.
  • Document key rotation and revocation.

Reliability

  • Add idempotency to create paths.
  • Use bounded exponential backoff with jitter.
  • Verify webhook signatures and deduplicate event IDs.
  • Exercise cancellation, timeout and deterministic failure paths in sandbox.

Files and retention

  • Use direct/multipart uploads for large inputs.
  • Choose an explicit retention policy.
  • Do not persist expiring signed download URLs as durable identifiers.
  • Delete data when your workflow no longer requires it.

Operations

  • Log request, Job and client reference IDs.
  • Alert on sustained webhook failures and conversion failure-rate changes.
  • Track usage and concurrency before quota becomes a customer-visible issue.
  • Link operators to the status page and internal runbook.

Before launch