API & webhooks

Publish updates from CI, a release script, or any webhook by POSTing to your project.

Get an API key

Open the project's SettingsAPI key (webhooks)Generate API key. Copy the key immediately — it's shown only once. Each project has one key; Regenerate replaces it and Revoke disables it.

Create an update

curl -X POST https://updatekit.io/api/v1/projects/<public-key>/updates \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"New release","content":"What changed","type":"new"}'

Body fields

  • title (required) — headline.
  • content (required) — Markdown body.
  • type (optional) — an update-type key (defaults to new).
  • status (optional) — published (default) or draft.
  • version, downloadUrl (optional) — for the inline timeline widget.

A successful call returns 201 with the new update's id, slug, and status.