Production Checklist
A pre-launch checklist that catches the issues we see most in support tickets after go-live. Walk through every item before flipping production traffic.
Pre-Launch Overview
Going to production means your application is serving real users with real data. MemorySync is designed for production use from day one, but there are configuration and security steps that must be completed before you expose the API to live traffic.
This checklist covers the seven areas most likely to cause issues: API key hygiene, webhook security, rate limiting, audit retention, health verification, environment configuration, and middleware ordering. Complete every item — skipping even one can lead to data leaks, quota exhaustion, or silent failures.
API Key Rotation
API keys are the primary authentication mechanism for the memory API. Before go-live:
- Rotate development keys. Any API key used during development or staging should be revoked. Generate fresh production keys through the dashboard.
- Scope keys to projects. Each API key is scoped to a specific project via the
X-Project-IDheader. Never share a single key across multiple projects. - Store keys in secrets. API keys must live in your secrets manager or environment variables — never in source code, config files, or client-side bundles.
- Enable usage tracking. MemorySync automatically records per-key usage metrics (request count, last used timestamp). Verify these metrics appear in your dashboard after the first production request.
Webhook Security
If you use webhooks to receive event notifications, verify these security settings:
- HTTPS endpoints only. The webhook delivery worker rejects HTTP endpoints in production. All webhook URLs must use TLS.
- Signature verification. Every webhook delivery includes an HMAC-SHA256 signature in the headers. Your receiver must verify this signature against your webhook secret to prevent spoofed deliveries.
- Retry behavior. Failed deliveries are retried with exponential backoff. After exhausting retries, events are moved to a dead-letter queue. Monitor the dead-letter count to detect endpoint failures.
- Delivery worker health. Webhook deliveries are dispatched asynchronously in the background. They start automatically on boot and drain in-flight deliveries on graceful shutdown.
Rate Limit Configuration
Rate limiting runs as middleware — it returns 429 responses before any business logic executes:
| Setting | What to verify |
|---|---|
| Per-key limits | Each API key has configurable request-per-second and request-per-minute limits. Set these to match your expected peak traffic. |
| Plan-quota behavior | When your monthly plan quota for adds or queries is exhausted, the platform silently degrades: requests return 200 OK with an empty result, no memory is stored, and the usage counter stops growing. Watch the Quota tile on the Billing dashboard to detect this before it impacts users. See the Silent Degradation page for the full contract. |
| Burst tolerance | The rate limiter uses a sliding window. Configure the window size to accommodate legitimate burst patterns. |
Audit Log Retention
MemorySync records every API call in the audit log for compliance. Before go-live, configure the retention policy:
- Default retention. Audit logs are retained for 90 days by default. Enterprise plans can extend this.
- Automatic enforcement. The platform purges expired audit entries automatically once they pass the retention window — no operational action is required from your team.
- Tombstone records. Deleted data leaves tombstone markers for 90 days to prevent resurrection from any backup. Tombstones are cleaned up automatically once they expire.
- Compliance requirements. If your organization is subject to GDPR, CCPA, or SOC 2, verify that your retention period meets regulatory requirements. Some frameworks require longer retention.
Health Endpoint Verification
MemorySync exposes a GET /health endpoint that checks the status of all critical platform dependencies. Before go-live, confirm the response returns "status": "ok":
- Overall status. The endpoint returns
okwhen all internal services are reachable and operational, ordegradedwhen one or more services are unavailable. - No authentication required. The health endpoint is publicly accessible and rate-limited to 5 requests/second per IP — ideal for load balancer health checks and container orchestrator readiness probes.
- What to do when degraded. A degraded response means some features (e.g., semantic recall or caching) may be temporarily unavailable. Core API operations may still work. Check the MemorySync status page for ongoing incidents.
Point your load balancer or container orchestrator at GET /health for liveness and readiness probes.
First Five Minutes Checklist
MemorySync is a fully managed cloud platform — you do not need to provision databases, configure encryption, or manage infrastructure. Before routing production traffic, verify these steps in your dashboard:
| Step | Details |
|---|---|
| Generate production API keys | Create dedicated API keys for production. Do not reuse development or staging keys — revoke those after go-live. |
| Set project scoping | If your app serves multiple tenants or products, create separate projects and pass the correct X-Project-ID header with each request. |
| Configure environment | Ensure your API key is set to the production environment. Development and production memories are isolated — queries in one environment cannot see data from the other. |
| Register webhook URLs | If you use webhooks, register your production HTTPS endpoint in the dashboard. Verify the HMAC signature in your receiver. |
| Review plan limits | Check your plan’s monthly add and query quotas on the Billing dashboard. Configure usage alerts (75%, 90%, 100% thresholds) so your team is notified before the platform begins silently degrading requests. |