Documentation

Quick Start

Create an account — Sign up at /sign-up

Create your changelog — Give it a name and slug

Add your first entry — Click "New Entry" in the dashboard

Publish — Hit publish and share the link

Your public changelog is instantly available at: changelog.someshovels.com/c/your-slug

Writing Great Entries

Be specific — "Fixed login bug" → "Fixed session timeout on mobile Safari"

Lead with impact — Start with what users gain, not what you did

Use categories — New Feature, Improvement, Bug Fix, Security, etc.

Add context — Link to docs, include screenshots when helpful

Authentication

Include your API key in the Authorization header:

curl https://changelog.someshovels.com/api/v1/entries \
  -H "Authorization: Bearer your_api_key"

Generate API keys in Settings → API Keys.

Endpoints

List Entries

GET /api/v1/entries

Query params: status, type, limit, offset

Create Entry

POST /api/v1/entries
Content-Type: application/json
{
  "title": "New Feature: Dark Mode",
  "slug": "dark-mode",
  "summary": "Toggle dark mode in settings",
  "body": "Full markdown body...",
  "updateType": "new_feature",
  "status": "draft"
}

Update Entry

PATCH /api/v1/entries/:id

Delete Entry

DELETE /api/v1/entries/:id

Rate Limits

| Plan | Requests/minute | |------|-----------------| | Free | 60 | | Pro | 300 | | Enterprise | Unlimited |

Headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Setup

Go to Settings → Notifications

Click Add Webhook

Enter your endpoint URL

Select events to subscribe to

Events

entry.published — Entry goes live

entry.updated — Published entry modified

entry.deleted — Entry removed

entry.scheduled — Entry scheduled for future

Payload

{
  "event": "entry.published",
  "timestamp": "2026-03-02T12:00:00Z",
  "entry": {
    "id": "abc123",
    "title": "New Feature",
    "slug": "new-feature",
    "summary": "...",
    "updateType": "new_feature",
    "publishedAt": "2026-03-02T12:00:00Z"
  }
}

Security

Verify webhooks using the X-Signature header (HMAC-SHA256 of the payload).

Feed URLs

Each changelog has three feed formats:

RSS 2.0: /c/your-slug/feed.rss

Atom: /c/your-slug/feed.atom

JSON Feed: /c/your-slug/feed.json

Caching

Feeds are cached for 1 hour. After publishing a new entry, it may take up to 60 minutes to appear in feeds.

Custom Domains

If using a custom domain, feeds are available at:

https://changelog.yourdomain.com/feed.rss

Setup

Go to Settings → Domain

Enter your domain (e.g., changelog.yourdomain.com)

Add the DNS records shown: - CNAME: Point to cname.vercel-dns.com - TXT: Verification record

Click Verify

SSL is automatically provisioned via Let's Encrypt.

Troubleshooting

Verification failing? DNS changes can take up to 48 hours to propagate

SSL errors? Wait 5-10 minutes after verification for certificate issuance

Already have a CNAME? Remove existing records before adding ours