Guides & Documentation
Everything you need to know about using Shipstar to automate your product marketing workflow.
Account & billing
Invite teammates and manage your Team plan
The Team plan lets you collaborate with colleagues by pooling credits and sharing access to content review across your...
Understand plans, credits, and how usage is tracked
Shipstar offers three plans — Free, Solo, and Team — each with a monthly credit allowance used for content generation....
Getting started
Connect a GitHub repository to Shipstar
Shipstar reads commits from your GitHub repositories to generate content. Before any content can be generated, you need...
Create and manage API keys
API keys let you authenticate with the Shipstar API from scripts, CI pipelines, or any external tool. You create and...
Create your account and generate your first changelog
Shipstar connects to your GitHub repositories and turns your recent commits into polished marketing content —...
Integrations
Connect Slack to post release updates automatically
Shipstar can push any piece of generated content directly to a Slack channel, so your team and users hear about every...
Post Twitter/X threads automatically on publish
Shipstar can post Twitter/X threads the moment you publish them, or on a recurring schedule, so your audience hears...
Publish help articles to Featurebase
Shipstar integrates with Featurebase to create help center articles directly in your Featurebase workspace. You connect...
Sync knowledge base articles to Intercom
Shipstar can generate categorized help center articles from your recent commits and sync them directly to your Intercom...
Product guides
Embed your changelog on your own website
Shipstar includes an embeddable changelog widget that lets you display your published changelog directly on your own...
Publish content and share it with a public URL
Once Shipstar has generated a piece of content and you're happy with it, publishing gives it a permanent public URL...
Review and edit generated content before publishing
Every piece of content Shipstar generates goes through a simple lifecycle before it's published: it starts as pending...
Schedule automatic content generation
Shipstar's scheduling feature lets you set up recurring calendar events that automatically trigger content generation...
Set content guidelines to control tone and focus
Content guidelines give you control over how Shipstar writes — what register it uses, what it includes or skips, and...
Use the Mailing Lists feature to send release notes emails
Shipstar's Mailing Lists feature lets you build a list of subscribers and deliver Release Notes Email content to them...
What content types Shipstar can generate
Shipstar can generate twelve types of content from your GitHub commits. Each type has a specific format, length, and...
Troubleshooting
Content generation is stuck in 'pending' or 'processing'
Content generation in Shipstar runs asynchronously. When you trigger a generation request, you receive a content_id and...
Fix authentication errors with your API key
A 401 Unauthorized response means Shipstar could not verify your identity from the credentials you sent. This is almost...
Handle rate limits and 429 Too Many Requests errors
Shipstar enforces per-endpoint rate limits to keep the API reliable for everyone. If you send requests too quickly, you...
What to do when content generation returns a 402 error
A 402 Payment Required response from a generation endpoint means your team's monthly credit allowance is fully used up....
Ready to Automate Your Product Marketing?
Start generating changelogs, release notes, and social posts from your development workflow — free to get started.