Skip to content
Nordva Launch Nordva Launch Nordva Launch

Create or schedule a changelog entry

POST
/v1/changelog/entries

Creates a new changelog entry: published now, scheduled (scheduled_at), or a draft (status: "draft", nothing public or sent until it is published). notify_subscribers emails the confirmed subscribers when it publishes (public entries only, and only subscribers whose labels match); notify_in_app posts one broadcast to every user’s in-app bell when it publishes (left out, the project’s changelog_to_bell_default setting decides; never for a segment entry); notify_chat: false keeps the entry out of Slack and Discord webhook endpoints.

Display fields: cover_image_url (an https link to an image you host; nothing is uploaded or proxied), cta_label + cta_url (a button: http(s) URL or a path), labels (slugs from /v1/changelog/labels), audience (public, signed_in, or segment with a segment rule on Builder), pinned, expires_at (after it the entry leaves every public surface) and announcement ({ style: modal|banner|toast, until }, Indie and up; one entry per project at a time, and setting it ends the previous one, named in meta.announcement_replaced_entry_id). Images inside body_markdown must be https links too; javascript:, data:, vbscript: and file: links are refused.

Auth: Secret key only (nv_live_*). This endpoint modifies project content and must not be called from a browser.

Idempotency: Pass Idempotency-Key header to safely retry without creating duplicates.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string
<= 255 characters

Replay-safe identifier. Same key + same body returns the original response. Same key + different body returns 422.

Request Body required

Section titled “Request Body required ”
object
title
required
string
>= 1 characters <= 200 characters
body_markdown
required
string
>= 1 characters <= 50000 characters
version
string
>= 1 characters <= 64 characters
category
required
string
Allowed values: feature fix improvement security breaking
scheduled_at
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
status
string
notify_subscribers
boolean
notify_in_app
boolean
cover_image_url
Any of:
string
<= 2048 characters
cta_label
Any of:
string
>= 1 characters <= 40 characters
cta_url
Any of:
string
<= 2048 characters
labels
Array<string>
<= 10 items
audience
string
Allowed values: public signed_in segment
segment
Any of:
object
match
required
string
default: all
Allowed values: all any
rules
required
Array
>= 1 items <= 10 items
One of:
object
type
required
string
key
required
string
/^[a-z][a-z0-9_]{0,39}$/
op
required
string
Allowed values: eq neq in exists
value
Any of:
string
<= 200 characters
pinned
boolean
expires_at
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
announcement
Any of:
object
style
required
string
Allowed values: modal banner toast
until
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
notify_chat
boolean

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Entry created

object
data
required
object
id
required
string
/^ce_[0-9A-HJKMNP-TV-Z]{26}$/
project_id
required
string
/^prj_[0-9A-HJKMNP-TV-Z]{26}$/
title
required
string
>= 1 characters <= 200 characters
body_markdown
required
string
version
required
Any of:
string
category
required
string
Allowed values: feature fix improvement security breaking
status
required
string
Allowed values: draft published scheduled archived
scheduled_at
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
published_at
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
created_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
updated_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
notify_subscribers
required
boolean
notify_in_app
required
boolean
notify_chat
required
boolean
public_url
required
string format: uri
cover_image_url
required
Any of:
string
cta_label
required
Any of:
string
cta_url
required
Any of:
string
labels
required
Array<object>
object
id
required
string
slug
required
string
name
required
string
colour
required
string
Allowed values: gray red orange amber green teal blue indigo purple pink
audience
required
string
Allowed values: public signed_in segment
segment
required
Any of:
object
match
required
string
default: all
Allowed values: all any
rules
required
Array
>= 1 items <= 10 items
One of:
object
type
required
string
key
required
string
/^[a-z][a-z0-9_]{0,39}$/
op
required
string
Allowed values: eq neq in exists
value
Any of:
string
<= 200 characters
pinned
required
boolean
expires_at
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
announcement
required
Any of:
object
style
required
string
Allowed values: modal banner toast
until
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
active
required
boolean
error
required
null
meta
object
key
additional properties

401

Section titled “401 ”

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties

403

Section titled “403 ”

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties

422

Section titled “422 ”

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties