record_buyer_ui_event
Record card health
Record content-free UI capability and recovery metrics. Does not change the transaction.
- Effect
- Read
- Required scopes
workspace:read- Workflow stages
- closing, discovery, transaction
- Data classes
- deadlines tasks, ui telemetry
- Operation cost
- 1 weighted units; additional domain limits may apply.
- Configurations
- Standard, Buyer UI v2
- Muse proposal
- Write. Records diagnostic UI events; does not change purchase terms or send a message. Meta makes the final classification during review.
Buyer approval and signing controls apply in addition to the scopes above. Read error and retry guidance before implementing recovery.
Input and output contracts
Returns structured content and a JSON text content block. Live discovery may compact a large output schema; execution validates the full contract below.
Input fields
Required applies within the containing object. Optional fields can be omitted; null is accepted only where listed. Field descriptions and constraints come from the source schema. The raw schema remains the complete contract.
| Field | Required | Meaning and constraints |
|---|---|---|
eventstring | Yes | Allowed: "capabilities", "rendered", "render_error", "save_conflict", "handoff_pending", "handoff_failed", "handoff_opened". |
resourceVersionstring | Yes | Pattern validation applies; see the raw schema. |
screenstring | No | Allowed: "terms", "package", "research", "documents", "action", "changes", "progress". |
toolsboolean | No | No additional description in the contract. |
fullscreenboolean | No | No additional description in the contract. |
linksboolean | No | No additional description in the contract. |
Output fields
Required applies within the containing object. Optional fields can be omitted; null is accepted only where listed. Field descriptions and constraints come from the source schema. The raw schema remains the complete contract.
| Field | Required | Meaning and constraints |
|---|---|---|
recordedboolean | Yes | Must be true. |
Raw input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"event": {
"type": "string",
"enum": [
"capabilities",
"rendered",
"render_error",
"save_conflict",
"handoff_pending",
"handoff_failed",
"handoff_opened"
]
},
"resourceVersion": {
"type": "string",
"pattern": "^[a-f0-9]{16}$"
},
"screen": {
"type": "string",
"enum": [
"terms",
"package",
"research",
"documents",
"action",
"changes",
"progress"
]
},
"tools": {
"type": "boolean"
},
"fullscreen": {
"type": "boolean"
},
"links": {
"type": "boolean"
}
},
"required": [
"event",
"resourceVersion"
],
"additionalProperties": false
}Full output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"recorded": {
"type": "boolean",
"const": true
}
},
"required": [
"recorded"
],
"additionalProperties": false
}Tool annotations
{
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
}Reference 00e5441a095c7e20. Download the full catalog.