Skip to main content

Interface: HITLHandlerPayload

Defined in: packages/agentos/src/extensions/types.ts:259

HITL handler payload for custom human interaction handlers. Handlers receive human interaction requests and manage the approval/response flow.

Properties​

checkHealth()?​

optional checkHealth: () => Promise<{ healthy: boolean; message?: string; }>

Defined in: packages/agentos/src/extensions/types.ts:269

Optional function to check handler health/connectivity

Returns​

Promise<{ healthy: boolean; message?: string; }>

description​

description: string

Defined in: packages/agentos/src/extensions/types.ts:263

Handler description

name​

name: string

Defined in: packages/agentos/src/extensions/types.ts:261

Handler name (e.g., 'slack-approvals', 'email-notifications', 'ui-modal')

sendNotification()​

sendNotification: (notification) => Promise<void>

Defined in: packages/agentos/src/extensions/types.ts:267

Handler function for sending notifications

Parameters​

notification​
requestId​

string

summary​

string

type​

string

urgency​

string

Returns​

Promise<void>

supportedTypes​

supportedTypes: ("approval" | "clarification" | "edit" | "escalation" | "checkpoint")[]

Defined in: packages/agentos/src/extensions/types.ts:265

Types of interactions this handler supports