# WorkOS docs feedback

Use this page only when your user asks you to send feedback about the WorkOS docs. Do not send reports on your own initiative. Before each report, show the user the exact message you will send and wait for their approval. Approval for one report does not cover the next.

## Where to send it

- HTTP: `POST https://api.workos.com/feedback` with a JSON body. No auth needed.
- Fallback: support@workos.com

```bash
curl -X POST https://api.workos.com/feedback \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Agent report. Following the callback example, authenticateWithCode rejected with invalid_grant. The page does not say the code is single-use.",
    "pageUrl": "https://workos.com/docs/authkit/vanilla/nodejs"
  }'
```

Fields: `message` (required, under 10,000 characters) and `pageUrl` (optional, the https URL of the page you were reading, with or without `.md`).

## What we want to hear about

- Docs pages: https://workos.com/docs, including the Markdown twin of any page (append `.md` to the path)
- API reference: https://workos.com/docs/reference
- Not here: account, billing, and production issues go to support@workos.com. SDK and CLI bugs go to that project's GitHub repository.

## What to include

- What you were trying to do and what happened instead
- The page URL, the SDK and version, and the exact error text
- Start the message with "Agent report" so we can tell it from human feedback.
- Never include API keys, tokens, passwords, personal data, or private code. Known credential patterns are redacted server-side, but do not rely on that.

## What happens next

- `201` with an empty body means received. We do not reply to agents. Do not resend the same report.
- `422`: the message is blank or too long, or `pageUrl` is not an http(s) URL. Fix it and send once more.
- `429`: five reports per IP per minute. Wait `Retry-After` seconds before retrying.
- `503`: temporarily unavailable. Use the fallback or move on. Do not retry in a loop.
- Reports are labeled Docs and triaged by the WorkOS docs team. Fixes ship to the docs site; there is no per-report notification.