AgentHooksConfig

Lifecycle event hooks grouped by event type. Each event is journaled once and delivered synchronously to every configured destination.

hooks object

Hook destinations keyed by lifecycle event type. n8n and tool_backend destinations can be mixed.

property name* object[]

Array [

webhook_urlWebhook Urlrequired

Relative hook path. For tool_backend lifecycle hooks use {client}/hooks/{endpoint}; it is resolved below the client-tools /clients/ base.

backend_typeHookBackendType

Delivery backend. n8n calls the configured n8n host; tool_backend calls the client-tools service.

Possible values: [n8n, tool_backend]

Default value: n8n

tool_name object

LLM tool name. Used only when this configuration appears in hook_tools.

anyOf

• string
• null

string

refresh_ctx_afterRefresh Ctx After

Reload lead and contact context after a successful lifecycle hook, for synchronous handlers that mutate them.

Default value: false

llm_description object

Instructions shown to the LLM for an external tool. Used only in hook_tools.

anyOf

• string
• null

string

wait_for_results_asyncWait For Results Async

Whether an external tool returns later through the asynchronous call-result callback.

Default value: false

wait_for_results_async_timeout_secondsWait For Results Async Timeout Seconds

Maximum wait for an asynchronous tool result, in seconds.

Default value: 600

]

AgentHooksConfig

{
  "hooks": {}
}