ChangeCrab logo ChangeCrab
Log in

Changelog API

Publish changelogs from your release workflow.

Use the ChangeCrab API on paid plans and active trials to create changelogs, publish posts, manage categories, and connect release work to internal tools.

Start API trial Read API docs

REST API access is available on paid plans and active trials.

REST API CI/CD MCP-ready
API Create and manage changelogs programmatically
Posts Create, update, list, and delete changelog entries
Trial Try paid automation before committing
api.changecrab.com/changelogs/{id}/posts
API workflow

Release automation that still publishes to a real changelog

Build

Release script has context

The release process knows title, markdown body, category, affected users, and publish intent.

CI/CD JSON Owner
Call

Create or update the post

The API sends structured release notes into ChangeCrab with API-key authentication.

POST PUT X-API-Key
Distribute

Public channels stay aligned

The approved entry powers the public page, widget, RSS, subscribers, and MCP workflows.

Page Widget RSS

Why this matters

A changelog API is useful when release notes are part of shipping, not an afterthought.

The API lets engineering, platform, or agent workflows create structured update records without losing the customer-facing page.

Automation reduces missed updates

Release scripts and internal tools can create the changelog record while the context is fresh.

Structure beats scraping

API and MCP workflows give agents and tools explicit changelog data instead of brittle browser automation.

Humans still control publish quality

Even with API creation, teams can keep review, scheduling, and subscriber alert decisions in the workflow.

Workflow

API workflow for release communication

Frame

Create an API key

Use a paid or trial account to create credentials for your internal tool, script, or agent.

Build

Map release data

Send title, markdown body, category, status, and changelog ID from your release system.

Publish

Create or update entries

Use the API for draft creation, post updates, release scripts, or internal admin tools.

Measure

Publish through ChangeCrab

Let the entry feed your public page, widget, RSS, subscribers, and analytics.

Before and after

API workflow versus manual dashboard publishing

Manual publishing Best when the team is small and release notes are occasional or editorial.
API publishing Best when releases are frequent, structured, generated, or tied to CI/CD and internal tools.
Buyer impact Premium is worth it when automation removes recurring work and prevents missed communication.

Example artifact

API example for creating a changelog post

The API should receive structured data, not a vague blob of release text.

Start API trial

Create a post

curl -X POST https://changecrab.com/api/changelogs/123/posts \
  -H "X-API-Key: CHANGECRAB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Saved report filters","summary":"Teams can reopen recurring report views in one click."}'
POST JSON API key

Fields worth sending

{
  "title": "Saved report filters",
  "category": "Improved",
  "body": "Customer-ready markdown with links",
  "status": "draft"
}
Title Category Draft

Automation rules

Use least-privilege keys
Store secrets outside source control
Keep review for customer-facing posts
Log failures and retries
Avoid duplicate entries
Security Review Reliability

API guardrails

The API is for release systems that need a reliable destination.

This page converts better when it is honest about access, authentication, and approval.

Paid or trial access keeps automation intentional

General REST API workflows are for paid plans and active trials, where release operations need structure.

API keys should be treated like release secrets

Store keys outside source control, log failures, and avoid duplicate posts when retrying release jobs.

Draft-first workflows are often safer

Create or update a draft through the API, then review public copy and subscriber alerts before publishing.

What you get

API access for mature changelog workflows

Resources

  • Create changelogs
  • List and manage posts
  • Manage categories
  • Import RSS workflows

Automation

  • CI/CD scripts
  • Internal release tools
  • MCP server workflows
  • Agent-assisted publishing

Publishing

  • Public pages
  • Widget
  • RSS feed
  • Subscribers and analytics

Buyer questions

Questions that come up before teams choose this workflow.

Is the ChangeCrab API available on free plans?

General REST API access is available on paid plans and active trials. Free plans are best for manual changelog publishing.

Can the API work with CI/CD?

Yes. Use it from release scripts, internal tools, or deployment workflows when changelog publishing should be part of shipping.

Should API-created posts publish automatically?

Only when the workflow is safe and well tested. Many teams create drafts through the API and keep human review before public publish or subscriber alerts.

Related pages

Keep exploring ChangeCrab workflows.

These pages share adjacent product communication use cases.

Changelog Integrations Use ChangeCrab integrations, webhooks, Zapier, API workflows, Slack, Discord, WordPress, and StatusCake context without losing the public source of truth. Slack Integration Connect ChangeCrab updates to Slack so support, success, sales, product, and launch teams see what shipped without replacing the public changelog. Discord Integration Use ChangeCrab with Discord to share changelog updates in communities, beta servers, customer groups, and product channels while keeping the full release note on a public URL. Zapier Integration Use the ChangeCrab Zapier integration to create changelog posts from no-code workflows, release checklists, forms, issue trackers, and internal launch processes.

Connect your release system to your customer update system.

Start an API trial and create the next changelog post from your workflow instead of copying it by hand.

Start API trial Read API docs