Payload schema
methodstring
HTTP method of the held request.
urlstring
Destination URL of the held request.
headersRecord<string, string>
All headers as they would be forwarded, placeholder form.
bodyobject | nulloptional
A bounded inspection prefix in placeholder form plus the complete body's SHA-256.
encoding"utf8" | "base64"
contentstring
originalByteLengthintegeroptional
sha256string
truncatedbooleanoptional
secretPathsstring[]optional
Secret paths the request references — the "spends this secret" headline.
ruleKeystring
The rule that caught the request.
ruleDescriptionstringoptional
The matched rule's human-readable explanation, snapshotted at gate time.
streamContextobjectoptional
Host-minted durable stream context for the invocation that attempted this request.
kind: "script-execution"object
kind"script-execution"
streamPathstring
scriptRunRequestedEventOffsetinteger
executionIdstring
kind: "scope"object
kind"scope"
scopePathstring
expiresAtstring
ISO horizon after which the hold auto-rejects with reason expired.
Raw JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"method": {
"type": "string",
"description": "HTTP method of the held request."
},
"url": {
"type": "string",
"description": "Destination URL of the held request."
},
"headers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
},
"description": "All headers as they would be forwarded, placeholder form."
},
"body": {
"description": "A bounded inspection prefix in placeholder form plus the complete body's SHA-256.",
"anyOf": [
{
"type": "object",
"properties": {
"encoding": {
"type": "string",
"enum": [
"utf8",
"base64"
]
},
"content": {
"type": "string"
},
"originalByteLength": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sha256": {
"type": "string"
},
"truncated": {
"default": false,
"type": "boolean"
}
},
"required": [
"encoding",
"content",
"sha256"
]
},
{
"type": "null"
}
]
},
"secretPaths": {
"default": [],
"description": "Secret paths the request references — the \"spends this secret\" headline.",
"type": "array",
"items": {
"type": "string"
}
},
"ruleKey": {
"type": "string",
"description": "The rule that caught the request."
},
"ruleDescription": {
"default": "",
"description": "The matched rule's human-readable explanation, snapshotted at gate time.",
"type": "string"
},
"streamContext": {
"description": "Host-minted durable stream context for the invocation that attempted this request.",
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "script-execution"
},
"streamPath": {
"type": "string",
"pattern": "^\\/.*"
},
"scriptRunRequestedEventOffset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"executionId": {
"type": "string",
"minLength": 1
}
},
"required": [
"kind",
"streamPath",
"scriptRunRequestedEventOffset",
"executionId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "scope"
},
"scopePath": {
"type": "string",
"pattern": "^\\/.*"
}
},
"required": [
"kind",
"scopePath"
],
"additionalProperties": false
}
]
},
"expiresAt": {
"type": "string",
"description": "ISO horizon after which the hold auto-rejects with reason expired."
}
},
"required": [
"method",
"url",
"headers",
"ruleKey",
"expiresAt"
]
}