Preview a Playbook update
curl --request POST \
--url https://api-us.hihobbes.com/api/v1/playbook/update-previews \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"operationKey": "<string>",
"expectedSectionsEtag": "<string>",
"patches": [
{
"sectionKey": "<string>",
"operations": [
{
"path": "<string>",
"value": null
}
]
}
]
}
'import requests
url = "https://api-us.hihobbes.com/api/v1/playbook/update-previews"
payload = {
"operationKey": "<string>",
"expectedSectionsEtag": "<string>",
"patches": [
{
"sectionKey": "<string>",
"operations": [
{
"path": "<string>",
"value": None
}
]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
operationKey: '<string>',
expectedSectionsEtag: '<string>',
patches: [{sectionKey: '<string>', operations: [{path: '<string>', value: null}]}]
})
};
fetch('https://api-us.hihobbes.com/api/v1/playbook/update-previews', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"previewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiresAt": "2023-11-07T05:31:56Z",
"baseSectionsEtag": "<string>",
"proposedSectionsEtag": "<string>",
"productionVersion": 123,
"stagingVersion": 123,
"links": {
"staging": {
"target": {
"lane": "staging",
"revisionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revisionNumber": 123,
"revisionStatus": "<string>"
},
"url": "<string>",
"availabilityReason": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
},
"production": {
"target": {
"lane": "staging",
"revisionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revisionNumber": 123,
"revisionStatus": "<string>"
},
"url": "<string>",
"availabilityReason": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}
},
"changes": [
{
"sectionKey": "<string>",
"title": "<string>",
"action": "added",
"before": "<unknown>",
"after": "<unknown>"
}
],
"role": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isDefault": true,
"name": "<string>",
"selection": "explicit"
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}Preview a Hobbes Playbook update
Validate proposed changes and return a before-and-after summary without changing staging.
POST
/
api
/
v1
/
playbook
/
update-previews
Preview a Playbook update
curl --request POST \
--url https://api-us.hihobbes.com/api/v1/playbook/update-previews \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"operationKey": "<string>",
"expectedSectionsEtag": "<string>",
"patches": [
{
"sectionKey": "<string>",
"operations": [
{
"path": "<string>",
"value": null
}
]
}
]
}
'import requests
url = "https://api-us.hihobbes.com/api/v1/playbook/update-previews"
payload = {
"operationKey": "<string>",
"expectedSectionsEtag": "<string>",
"patches": [
{
"sectionKey": "<string>",
"operations": [
{
"path": "<string>",
"value": None
}
]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
operationKey: '<string>',
expectedSectionsEtag: '<string>',
patches: [{sectionKey: '<string>', operations: [{path: '<string>', value: null}]}]
})
};
fetch('https://api-us.hihobbes.com/api/v1/playbook/update-previews', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"previewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expiresAt": "2023-11-07T05:31:56Z",
"baseSectionsEtag": "<string>",
"proposedSectionsEtag": "<string>",
"productionVersion": 123,
"stagingVersion": 123,
"links": {
"staging": {
"target": {
"lane": "staging",
"revisionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revisionNumber": 123,
"revisionStatus": "<string>"
},
"url": "<string>",
"availabilityReason": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
},
"production": {
"target": {
"lane": "staging",
"revisionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revisionNumber": 123,
"revisionStatus": "<string>"
},
"url": "<string>",
"availabilityReason": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}
},
"changes": [
{
"sectionKey": "<string>",
"title": "<string>",
"action": "added",
"before": "<unknown>",
"after": "<unknown>"
}
],
"role": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isDefault": true,
"name": "<string>",
"selection": "explicit"
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}Last reviewed 2026-11-09
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.
Related docs
- Review the protected workflow for previewing and applying agent changes. Playbook and agent API guide
- Review the supported endpoint contract. Hobbes API overview
- Confirm the required key permissions. Authentication and scopes
Authorizations
bearerapiKeyHeader
Body
application/json
Response
Successful Response