VocalDocscontracts 1.65.0

PreCallHookCreated

The answer of a hook creation (1.52.0): the hook and its secret once.

An object with 20 fields.

Fields

FieldTypeRequiredDescription
allowed_agent_idsarray of AgentIdyesAgents besides the routed one whose published versions a response may select; empty allows only versions of the routed Agent.
consecutive_failuresintegeryes
created_atTimestampyes
defaultPreCallHookDefault or nullyes
directionsarray of PreCallHookDirectionyes
idPreCallHookIdyes
object"pre_call_hook"yes
on_failurePreCallHookOnFailureyes
phi_attested_atTimestamp or nullyesWhen an owner attested the endpoint for PHI; null before.
phi_attested_byMemberId or nullyes
previous_secret_expires_atTimestamp or nullyes
previous_secret_hintstring or nullyes
revisionintegeryes
scopePreCallHookScopeyes
secretPreCallHookSecret or nullyesThe secret, shown in this answer only; null on a replay under the same Idempotency-Key, which creates nothing.
secret_hintstringyesThe last four characters of the current secret.
statusPreCallHookStatusyes
timeout_msinteger or nullyesThe deadline of a request; null for the default of each direction.
updated_atTimestampyes
urlstringyesThe endpoint.

Used by

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