Skip to main content
POST
Preview a Playbook update
Requires playbook:write. Send restricted JSON Patch operations and a stable operationKey. Set expectedSectionsEtag to the current sectionsEtag. Hobbes validates the changes against a clone of staging. The preview does not change the Playbook and expires after 24 hours.

Authorizations

Authorization
string
header
required

Hobbes API key with the hb_live_ prefix.

Body

application/json
operationKey
string
required
Required string length: 1 - 255
expectedSectionsEtag
string
required
Required string length: 64
patches
SectionPatchGroup · object[]
required
Required array length: 1 - 25 elements

Response

Successful Response

previewId
string<uuid>
required
expiresAt
string<date-time>
required
baseSectionsEtag
string
required
proposedSectionsEtag
string
required
productionVersion
integer
required
stagingVersion
integer
required
changes
ChangedSection · object[]
required