Skip to content
Prompty

PermissionCompletedPayload

Payload for permission completion events — an approval decision was made.

---
title: PermissionCompletedPayload
config:
  look: handDrawn
  theme: colorful
  class:
    hideEmptyMembersBox: true
---
classDiagram
    class PermissionCompletedPayload {
        +string requestId
        +string toolCallId
        +string permission
        +boolean approved
        +string reason
        +dictionary result
        +RedactionMetadata redaction
    }
    class RedactionMetadata {
        +boolean sanitized
        +RedactedField[] fields
        +string policy
    }
    PermissionCompletedPayload *-- RedactionMetadata
requestId: perm_abc123
toolCallId: call_abc123
permission: tool.execute
approved: true
reason: user_approved
Name Type Description
requestId string Stable permission request identifier
toolCallId string Associated tool call identifier, when the permission gated a tool call
permission string Permission/action name that was decided
approved boolean Whether the requested permission was approved
reason string Decision reason, if available
result dictionary Host-specific decision result, such as a durable approval token or denial details
redaction RedactionMetadata Redaction state for sensitive decision fields

The following types are composed within PermissionCompletedPayload: