Authentication
Webhooks and Internal Secrets
How webhook, cron, test, and internal-control routes should be documented and called.
First created Last updated
End-to-end developer runbook
- Step 1 - Confirm the API area: Identify the product area, route module, endpoint path, and consumer before writing or calling code.
- Step 2 - Read the endpoint contract: Check method, auth, parameters, response, errors, side effects, and related docs.
- Step 3 - Prepare authentication and input: Use the right session, bearer token, webhook secret, or internal header. Validate body and query data before sending it.
- Step 4 - Make the request: Call the endpoint from the correct origin and environment. Keep credentials and secrets out of logs.
- Step 5 - Verify response, side effects, and records: Confirm status code, response shape, database records, external side effects, and audit evidence.
- Step 6 - Add tests, docs, and handoff notes: Update route inventory, consumer notes, and certification checks before depending on the change.
Secret-backed routes
- Action 1 - Identify the secret: Look for Auth hook secrets, cron secrets, test-control headers, social state secrets, and webhook signatures.
- Action 2 - Verify constant-time or signed validation: Webhook and callback routes should prove the sender before changing state.
- Action 3 - Document replay behavior: State tokens and hooks need expiry, nonce, or idempotency notes.
- Action 4 - Keep examples redacted: Show header names and fake values only.