VocalDocscontracts 1.65.0

PreCallHookCreateRequest

Creates a hook (1.52.0); omitted fields take timeout_ms null, default null, on_failure default, no allowed Agents and status active. Every issue is a detail of 422 validation_failed (PreCallHookIssueCode, and egress_denied for the URL).

An object with 8 fields.

Fields

FieldTypeRequiredDescription
allowed_agent_idsarray of AgentIdno
defaultPreCallHookAcceptInput or nullno
directionsarray of PreCallHookDirectionyes
on_failurePreCallHookOnFailureno
scopePreCallHookScopeyes
statusone of "active", "paused"nodegraded is set by the platform.
timeout_msinteger or nullno
urlstring (uri)yesThe endpoint: https, a public name, no IP literal and no embedded credentials, checked by the egress guard at save and at every request.

Used by

The operations whose parameters, request body or responses name this shape directly.