# Onset Documentation

## Docs

- [Quickstart](https://docs.onset.io/guides/quickstart.md): Set up your workspace and publish your first release in a few minutes.
- [Team Members](https://docs.onset.io/guides/team-members.md): Invite teammates to your workspace and choose what they can do.
- [Projects](https://docs.onset.io/guides/projects.md): Group releases that belong to the same product or initiative.
- [Labels](https://docs.onset.io/guides/labels.md): Tag releases so customers can filter for what matters to them.
- [Billing](https://docs.onset.io/guides/billing.md): Plans, limits, upgrading, and what happens when you downgrade.
- [Overview](https://docs.onset.io/guides/releases/overview.md): How release notes work in Onset, from draft to published.
- [Writing Releases](https://docs.onset.io/guides/releases/writing.md): Use the editor, Markdown, images, and media embeds to write clear updates.
- [AI Assistant](https://docs.onset.io/guides/releases/ai-assistant.md): Turn pull requests and issues into a first draft, and generate release summaries.
- [Publishing & Scheduling](https://docs.onset.io/guides/releases/publishing.md): Publish now or later, and notify subscribers, Slack, and Discord in one step.
- [Versioning](https://docs.onset.io/guides/releases/versioning.md): Attach version numbers to releases and flag pre-releases.
- [Visibility & Sharing](https://docs.onset.io/guides/releases/visibility.md): Private releases, share links, and pinning important updates.
- [Contributors](https://docs.onset.io/guides/releases/contributors.md): Credit the teammates behind each release.
- [Reactions](https://docs.onset.io/guides/releases/reactions.md): Let readers react to releases and see what actually lands.
- [Overview](https://docs.onset.io/guides/releases/import/overview.md): Migrate your existing release notes from Beamer, AnnounceKit, Changelogfy, Noticeable, or ReleaseNotes.io.
- [Import from AnnounceKit](https://docs.onset.io/guides/releases/import/announcekit.md): Bring your AnnounceKit posts into Onset from your public JSON feed.
- [Import from Beamer](https://docs.onset.io/guides/releases/import/beamer.md): Bring your Beamer posts into Onset using your Beamer API key.
- [Import from Changelogfy](https://docs.onset.io/guides/releases/import/changelogfy.md): Bring your Changelogfy posts into Onset from your public RSS feed.
- [Import from Noticeable](https://docs.onset.io/guides/releases/import/noticeable.md): Bring your Noticeable publications into Onset from your Newspage JSON feed.
- [Import from ReleaseNotes.io](https://docs.onset.io/guides/releases/import/releasenotesio.md): Bring your ReleaseNotes.io posts into Onset from your public RSS feed.
- [Overview](https://docs.onset.io/guides/subscribers/overview.md): Collect people who want to hear about your updates.
- [Subscriber Lists](https://docs.onset.io/guides/subscribers/lists.md): Segment your audience so the right people get the right updates.
- [Importing Subscribers](https://docs.onset.io/guides/subscribers/import.md): Bring your existing email subscribers into Onset from a CSV.
- [Appearance](https://docs.onset.io/guides/page/appearance.md): Brand your public page with logos, colors, and social previews.
- [Page Preferences](https://docs.onset.io/guides/page/preferences.md): Language, SEO, and default views for your public page.
- [Feeds](https://docs.onset.io/guides/page/feeds.md): RSS, Atom, and JSON feeds for your releases.
- [Custom Domains](https://docs.onset.io/page/custom-domains.md)
- [Email Whitelisted Page](https://docs.onset.io/page/privacy/email-whitelisted-page.md)
- [Password Protected](https://docs.onset.io/page/privacy/password-protected.md)
- [Custom From Address](https://docs.onset.io/email/custom-from-address.md): Send release notifications from your own email address to match your brand identity.
- [Custom Subject](https://docs.onset.io/email/custom-subject.md): Personalize your email subject line with dynamic placeholders for better engagement.
- [Overview](https://docs.onset.io/developers/widget/overview.md): Show your release notes inside your own app.
- [Install](https://docs.onset.io/developers/widget/install.md): It only takes a few minutes to install Onset widget on your website.
- [Configuration](https://docs.onset.io/developers/widget/configuration.md)
- [Methods](https://docs.onset.io/developers/widget/methods.md)
- [MCP Server](https://docs.onset.io/developers/mcp.md): Connect Onset to Claude, Cursor, VS Code, Codex and other AI clients to read and write your changelog in natural language.
- [Webhooks](https://docs.onset.io/developers/webhooks.md)
- [Incoming Webhooks](https://docs.onset.io/developers/incoming-webhook.md): Create releases and subscribers in Onset by sending a JSON POST from CI, a deploy script, or any external service.
- [Introduction](https://docs.onset.io/developers/api-reference/introduction.md)
- [Get workspace information](https://docs.onset.io/api-reference/workspace/get-workspace-information.md): Retrieve information about the current authenticated workspace, including its ID, name, slug, public page URL, and the configured release change types and roadmap status types
- [List milestones](https://docs.onset.io/api-reference/milestones/list-milestones.md): Retrieve a paginated list of milestones with optional filtering by status, visibility, project, and other criteria
- [Get milestone by ID](https://docs.onset.io/api-reference/milestones/get-milestone-by-id.md): Retrieve a specific milestone by its ID
- [Delete milestone](https://docs.onset.io/api-reference/milestones/delete-milestone.md): Delete a milestone by its ID
- [Update milestone](https://docs.onset.io/api-reference/milestones/update-milestone.md): Update an existing milestone
- [List releases](https://docs.onset.io/api-reference/releases/list-releases.md): Retrieve a list of releases with optional filtering
- [Create a new release](https://docs.onset.io/api-reference/releases/create-a-new-release.md): Create a new release in the workspace. Releases are always created as drafts — use POST /releases/{id}/publish to publish or schedule one.
- [Get release by ID](https://docs.onset.io/api-reference/releases/get-release-by-id.md): Retrieve a specific release by its ID
- [Delete release](https://docs.onset.io/api-reference/releases/delete-release.md): Delete a release by its ID
- [Update release](https://docs.onset.io/api-reference/releases/update-release.md): Update the content of an existing release. Cannot publish or unpublish — use POST /releases/{id}/publish for that.
- [Publish release](https://docs.onset.io/api-reference/releases/publish-release.md): Publish a draft or scheduled release to the changelog, either immediately or at a future date. Use this to publish a scheduled release early, or to move a scheduled release to a different date. Returns 400 if the release is already published.
- [List subscribers](https://docs.onset.io/api-reference/subscribers/list-subscribers.md): Retrieve a list of subscribers, newest first, with optional filtering by subscriber list
- [Create a new subscriber](https://docs.onset.io/api-reference/subscribers/create-a-new-subscriber.md): Create a new subscriber in the workspace
- [Get subscriber by ID](https://docs.onset.io/api-reference/subscribers/get-subscriber-by-id.md): Retrieve a specific subscriber by their ID
- [Delete subscriber](https://docs.onset.io/api-reference/subscribers/delete-subscriber.md): Delete a subscriber by their ID
- [Update subscriber](https://docs.onset.io/api-reference/subscribers/update-subscriber.md): Update an existing subscriber
- [List subscriber lists](https://docs.onset.io/api-reference/subscriber-lists/list-subscriber-lists.md): Retrieve a list of subscriber lists
- [Create a new subscriber list](https://docs.onset.io/api-reference/subscriber-lists/create-a-new-subscriber-list.md): Create a new subscriber list in the workspace
- [Get subscriber list by ID](https://docs.onset.io/api-reference/subscriber-lists/get-subscriber-list-by-id.md): Retrieve a specific subscriber list by its ID
- [Delete subscriber list](https://docs.onset.io/api-reference/subscriber-lists/delete-subscriber-list.md): Delete a subscriber list by its ID
- [Update subscriber list](https://docs.onset.io/api-reference/subscriber-lists/update-subscriber-list.md): Update an existing subscriber list
- [List webhooks](https://docs.onset.io/api-reference/webhooks/list-webhooks.md): Retrieve a list of webhooks
- [Create a new webhook](https://docs.onset.io/api-reference/webhooks/create-a-new-webhook.md): Create a new webhook in the workspace
- [Get webhook by ID](https://docs.onset.io/api-reference/webhooks/get-webhook-by-id.md): Retrieve a specific webhook by its ID
- [Delete webhook](https://docs.onset.io/api-reference/webhooks/delete-webhook.md): Delete a webhook by its ID
- [Update webhook](https://docs.onset.io/api-reference/webhooks/update-webhook.md): Update an existing webhook
- [List incoming webhooks](https://docs.onset.io/api-reference/incoming-webhooks/list-incoming-webhooks.md): Retrieve a list of incoming webhooks
- [Create a new incoming webhook](https://docs.onset.io/api-reference/incoming-webhooks/create-a-new-incoming-webhook.md): Create a new incoming webhook in the workspace
- [Get incoming webhook by ID](https://docs.onset.io/api-reference/incoming-webhooks/get-incoming-webhook-by-id.md): Retrieve a specific incoming webhook by its ID
- [Delete incoming webhook](https://docs.onset.io/api-reference/incoming-webhooks/delete-incoming-webhook.md): Delete an incoming webhook by its ID
- [Update incoming webhook](https://docs.onset.io/api-reference/incoming-webhooks/update-incoming-webhook.md): Update an existing incoming webhook
- [List projects](https://docs.onset.io/api-reference/projects/list-projects.md): Retrieve a paginated list of projects in the workspace
- [List labels](https://docs.onset.io/api-reference/labels/list-labels.md): Retrieve a paginated list of labels in the workspace
- [List contributors](https://docs.onset.io/api-reference/contributors/list-contributors.md): Retrieve a paginated list of contributors (workspace members) that can be assigned to releases
- [Google Analytics](https://docs.onset.io/integrations/google-analytics.md): Measure release note engagement by tracking page views in your existing analytics.
- [Plausible](https://docs.onset.io/integrations/plausible.md): Track page views on your release notes with privacy-friendly, cookieless analytics.
- [Fathom](https://docs.onset.io/integrations/fathom.md): Track page views on your release notes with simple, privacy-first analytics from Fathom.
- [Instatus](https://docs.onset.io/integrations/instatus.md): Connect Instatus to keep customers informed of service reliability next to your updates.
- [Status.io](https://docs.onset.io/integrations/statusio.md): Display system health and downtime from Status.io directly on your Onset page.
- [Statuspage](https://docs.onset.io/integrations/statuspage.md): Show real-time uptime and incidents from Statuspage alongside your product updates.
- [Statuspal](https://docs.onset.io/integrations/statuspal.md): Share live status and incidents from StatusPal together with your product communications.
- [incident.io](https://docs.onset.io/integrations/incidentio.md): Share live status and incidents from incident.io together with your product communications.
- [Discord](https://docs.onset.io/integrations/discord.md): Get notified in Discord channels when new releases are published.
- [Slack](https://docs.onset.io/integrations/slack.md): Get notified in Slack channels when new releases are published.
- [GitHub](https://docs.onset.io/integrations/github.md): Automatically create release notes from pull requests.
- [Linear](https://docs.onset.io/integrations/linear.md): Automatically create release notes from Linear issues.
- [Jira](https://docs.onset.io/integrations/jira.md): Automatically create release notes from Jira issues.
- [Zapier](https://docs.onset.io/integrations/zapier.md): Connect Onset to thousands of apps and automate your release workflow.

## OpenAPI Specs

- [openapi](https://docs.onset.io/api-reference/openapi.json)

## Optional

- [Release Notes](https://releases.onset.io/releases)
- [Blog](https://www.onset.io/blog)