Nik Richers
c3516c5b0b
Self-review against the OpenAPI spec and Studio code found claims that the draft got wrong: - Drop the dashboard procedure. The Studio webhooks UI reads from PLATFORM_WEBHOOKS_MOCK_DATA and calls no API, so the documented flow creates nothing. Document the Management API, which is shipped. - A manual retry is a single attempt. The spec states automatic retries don't apply to manual ones, contrary to what the draft claimed. - signing_secret is required on create, not an optional alternative to a dashboard-generated secret. - Add the `*` event type for subscribing to every event. - Scope URL validation to what the spec states and drop the unverified claim about placeholder domains being rejected. - payload.actor can be null itself, so reading actor.user_id unguarded breaks on platform-initiated events. - Remove the advice to drop events older than a per-project timestamp. It discards distinct events rather than duplicates. Also applies the style guide critic pass: removes the redundant best practices section, the positional references, and the roadmap phrasing.
Reference Docs
Supabase Reference Docs
Maintainers
If you are a maintainer of any tools in the Supabase ecosystem, you can use this site to provide documentation for the tools & libraries that you maintain.
DocSpec
We use documentation specifications which can be used to generate human-readable docs.
- OpenAPI: for documenting API endpoints.
- SDKSpec (custom to Supabase): for SDKs and client libraries.
- ConfigSpec (custom to Supabase): for configuration options.
- CLISpec (custom to Supabase): for CLI commands and usage.
The benefit of using custom specifications is that we can generate many other types from a strict schema (eg, HTML and manpages). It also means that we can switch to any documentation system we want. On this site we use Next.js, but on Supabase's official website, we use a custom React site and expose only a subset of the available API for each tool.
Contributing
To contribute to docs, see the style guide for how to write a page, and the developers' guide and contributing guide for repo mechanics. If you write with an AI coding agent, use the /write-the-docs skill to draft and /edit-the-docs to revise an existing page.