docs(self-enterprise): resync docs with current dashboard UI, webhooks, and SDK#22
Merged
Merged
Conversation
…age events Re-audited the docs against the current frontend, control-plane, and SDK and corrected the drift from the recent dashboard changes: - Navigation: API keys and Webhooks moved out of Settings into the sidebar Developer section. API keys are now generated on Developer → API keys (org-scoped, Test|Live strip, "Generate key", 2-active-keys-per-env cap, owner/admin only). Webhooks are under Developer → Webhooks. Updated every "Deploy tab" / "Settings → Webhooks" reference. - Product page tabs are Configure / Test / Live / Activity log / settings (the old single Deploy tab is gone); flowId + SDK snippets live on Test/Live, which gate until publish. The product "settings" tab is Archive + a usage snapshot. - Security level relabeled Standard / Hi-security in the UI (enum stays biometric); activity log shows "High Security". - Webhook docs now cover only verification.completed — the storage_committed / storage_failed events are no longer delivered to customer endpoints. Trimmed events, overview, verify-webhooks, best-practices, api-reference, nodejs. - Billing: dropped the non-existent low-balance warning. - Refreshed the api-key-test screenshot. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Senior review feedback: - Self Pass quickstart now opens with a loud banner: Enterprise users are in the wrong place, on Enterprise you do NOT install @selfxyz/qrcode or render your own QR, with a link to the Enterprise quickstart. - Enterprise SDK reference: drop the misleading "(or render it as a QR code)" and state plainly that you redirect to the hosted verificationUrl. - Migration guide: stop advising Pass users to keep rendering their own QR; redirect to verificationUrl and remove @selfxyz/qrcode. - Dashboard webhooks: require the full URL including the path, with a warning that a bare domain returns 200 from the page route and swallows deliveries. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…view Add a small info banner pointing Enterprise users to the Enterprise quickstart on the Self Pass overview and the frontend/backend API references, so people who land there don't render their own QR or run the verifier when they meant to use the managed platform. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The create flow changed (webhook-endpoints service + "Save" split): saving an endpoint does no reachability probe and returns the signing secret immediately; reachability is a separate, repeatable "Send Test Request" on the saved row. - dashboard/webhooks: drop "Stand up an endpoint first" + the 200-stub boilerplate; new flow is Add webhook -> Save (secret revealed once) -> verify signature -> optional Send Test Request; add Rotate secret to managing. - quickstart step 6: no reachable-first prerequisite; Save and copy the secret, Send Test Request once the handler is deployed. - webhooks overview + SDK verify-webhooks: drop "must return 2xx to be saved". Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
kartikmehta8
changed the title
…ibility section - credits-and-usage: replace the illustrative 1/2/3 with the product-confirmed costs (Pre KYC 25, Age Verification 10, Proof of Human 10) from packages/lib check-costs.ts (ATOMIC_PRICES, SELF-3046); note the cost is fixed at session creation. - sdk/nodejs: remove the Compatibility section — its semver promise contradicted the "0.x may break" line, and the passthrough note already lives in the webhook event catalog. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The delivery's signature headers are vendor-specific, so stop naming them in the docs. Integrators use the SDK (which reads the headers off the request itself) and the payload's verification_id. - verify-webhooks / api-reference: SDK examples pass the whole request headers object instead of naming individual signature headers. - signature-verification: drop the manual HMAC scheme and the other-languages header detail; the SDK is the supported path. - overview: remove the Headers block; dedupe on verification_id. - best-practices / troubleshooting: log and correlate by verification_id. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
shazarre
approved these changes
Jun 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Re-audited the Self Enterprise docs against the current code (dashboard-web, control-plane-api, the webhook-endpoints + dispatcher services, and the Enterprise SDK) and corrected the drift from the recent dashboard, webhook, and SDK changes. Also disambiguates Self Enterprise from the open-source Self Pass SDK so misdirected users land in the right place.
What changed
Self Enterprise — resync with current product
biometric); activity log shows "High Security".verification.completed— the storage events are no longer delivered to customer endpoints.verification_id; dropped the manual HMAC scheme.packages/libcheck-costs.ts, replacing the illustrative 1/2/3.0.x; pin a version).Self Enterprise ≠ Self Pass
verificationUrland never render your own QR (@selfxyz/qrcode).Commits
b2c7879)7cec3fd)92f8c4c)34f7cda)bca9c0f)17ac6a5)821f7e1)