enableDebugEvents

View as MarkdownOpen in Claude

Enable real-time debug event webhooks from the AI module during calls. When enabled, the SDK automatically wires a debug_webhook_url into the AI parameters and registers a /debug_events endpoint that receives event POSTs from the SignalWire platform.

Events are logged via the agent’s structured logger. Optionally, register a custom handler by overriding onDebugEvent() to react to events programmatically.

Parameters

level
numberDefaults to 1

Debug event verbosity level.

  • 1 — High-level events: barge, errors, session start/end, step changes
  • 2+ — Adds high-volume events: every LLM request/response, conversation_add

Returns

AgentBase — Returns this for method chaining.

Example

1import { AgentBase } from '@signalwire/sdk';
2
3const agent = new AgentBase({ name: 'debug-agent', route: '/debug' });
4agent.setPromptText('You are a helpful assistant.');
5agent.enableDebugEvents(1);
6await agent.serve();