Changelog entries

Public release-note style entries published to the org's customer-facing changelog feed.

A changelog entry is a published release note — typically announcing a new feature, bug fix, or improvement. Entries are visible on your organization's public changelog feed and can be syndicated via webhooks or email subscribers.

The API lets you create and list changelog entries. Updating and deleting individual entries is dashboard-only in v1.

The changelog entry object

idstring

Required

A unique identifier for the entry (UUID).

titlestring

Required

The entry title (1–512 chars).

contentstring

The entry body — typically markdown or rich-text. May be null.

slugstring

Required

URL-safe slug derived from the title.

status_codestring

Required

Workflow status. Common values: "draft", "published", "scheduled".

show_on_portalboolean

Required

Whether this entry is visible on the public-facing changelog page.

featured_image_urlstring

URL of the hero image. May be null.

author_idstring

UUID of the user listed as the entry's author. May be null.

scheduled_atstring

ISO 8601 timestamp at which this entry will publish (when status_code = "scheduled"). May be null.

published_atstring

ISO 8601 timestamp at which this entry was published. May be null for drafts.

created_atstring

Required

ISO 8601 timestamp at which the entry was created.

updated_atstring

Required

ISO 8601 timestamp of the most recent update.

Example changelog entry object

{
  "id":    "11ab3ef8-b8cd-cd15-01ba-changelog0001",
  "title": "v1.2 release: dark mode + faster search",
  "content": "We shipped two of the most-requested features...",
  "slug": "v1-2-release",
  "status_code": "published",
  "show_on_portal": true,
  "featured_image_url": null,
  "author_id": "cc3c3ef8-b8cd-cd15-01ba-adminuser001",
  "scheduled_at": null,
  "published_at": "2026-05-01T10:00:00.000Z",
  "created_at":   "2026-04-30T15:30:00.000Z",
  "updated_at":   "2026-05-01T10:00:00.000Z"
}

What you can do

Create an entry

Publish a new changelog entry, optionally with type and labels.

List entries

Paginated list with optional type and label filters.

Was this page helpful?

Last updated 1 week ago

Built with Documentation.AI