Skip to main content
For RxNote engineers working in the rx-note-web repository. The local app runs the same /api/v1 code as production, against the dev database.
1

Environment

INTEGRATION_SECRETS_KEY must be set (it seals webhook secrets). The API is behind the PUBLIC_API flag, which migration 0102 turns on in the dev database.
2

Database

The API’s tables come from migration 0102_public_api_v1. Once per database:
The runner prints its target and refuses anything but the dev database.
3

Create a test key

For your own RxNote account (a personal key), or for your organization:
The secret (rxn_test_…) is printed once. Keys can also be created in the app under Settings → API.
4

Run the app

With DISABLE_INNGEST on (the usual local setup), visits are processed inside the dev server — no Inngest CLI needed.
5

Call it

Then follow the quickstart with RXNOTE_API pointing at localhost — or use Try it in the local docs preview (below) with the Local development server selected and your key in the Authorization field.

​
Previewing these docs

Try it sends requests straight from your browser to the API (no Mintlify proxy), so the API must allow the docs’ origin. Outside production it always allows http://localhost:3333; deployed environments allow the origins in API_CORS_ORIGINS (the hosted docs domain), set in SSM. The API reference is generated from the code: after changing lib/api/schemas.ts or lib/api/openapi.ts, run pnpm api:openapi. pnpm check fails while the generated file is stale.
The dev database is shared. Use synthetic test patients only.