Changelog

Coming

• Webhook delivery: story.submitted, story.approved, story.rejected, story.published and story.unpublished, signed per Standard Webhooks, retried for about eleven hours.
• GET /v1/webhook_endpoints and GET /v1/webhook_deliveries (scope webhooks:read).
• Endpoints are added, tested, turned off and on in the Armage workspace.
• OpenAPI document 1.2.0 describes the webhook events (webhooks).
• These pages.

Live

• Organization API keys: armk_live_ and armk_test_, scoped, expiring, revocable, audited.
• GET /v1/stories, /v1/stories/{id}, /v1/approvals, /v1/feed.json, /v1/feed.xml.
• Per-key (300 a minute) and per-IP rate limits; keyset pagination; one error shape.

• /v1 is the version. New routes, optional parameters, scopes, response fields and event types are added to it without notice in advance; they are listed here when they ship.
• Breaking changes get /v2. Removing or renaming a field, changing a type or a default, tightening validation: /v1 keeps working beside /v2.
• Six months' notice. A route being retired answers with a Deprecation header (RFC 9745) and a Sunset header (RFC 8594) at least six months before it stops, and the retirement is announced here.
• Security fixes may change behavior at once when leaving it would put data at risk; they are listed here too.