About the CMS Compliance API

The CMS Compliance API captures compliance-related changes to a site's CMS content and broadcasts them for review. When a user creates, updates, or unpublishes a data item, the API packages the affected content and emits a webhook that oversight tools can act on.

With the CMS Compliance API, you can:

• Submit a CMS content action (create, update, or unpublish) on a data item for compliance review.
• Capture the affected content automatically, including both its current published version and its proposed draft version.
• Receive a webhook for each submitted action, and act on it in your own review or audit system.

The API reads the affected content from the site's CMS, so a review request always carries the actual data items involved. These items are returned as CMS data items.

How it works

The API turns a single content action into one review request.

A review request is produced when a user creates, updates, or unpublishes a data item and submits the action for review.

Depending on the action, the review request carries the content that matters:

• CREATE: the proposed draft only, because nothing is live yet.
• UPDATE: both the current published version and the proposed draft.
• UNPUBLISH: the current published version only.

The API then emits the Review Requested webhook, carrying the action, the captured content, and who submitted it. Any authorized party can subscribe to it to review, audit, or forward the change.

The currentDataItem is what's live right now, and the proposedDataItem is the change that takes effect once approved. Comparing the two shows exactly what a change would alter.

Before you begin

It's important to note the following points before starting to code:

• To consume review requests, subscribe to the Review Requested webhook. The API doesn't store review requests, so there's no endpoint to query them later.
• The DELETE action isn't currently supported and returns an error. Support is planned for the future.

Use cases

• Review CMS content changes for compliance
• Forward content changes to an external compliance system

Terminology

• Compliance review request: The record of a single CMS content action submitted for review, including the action, the affected content, and who submitted it.
• Current version: The published, live version of a data item. Subject to change.
• Proposed version: The draft version of a data item, which takes effect once approved.

See also

• CMS Data Items API