setWebHookUrl | SignalWire

Override the default webhook URL used for SWAIG function calls in the generated SWML document. By default, the SDK computes this URL from the agent’s host, port, and route. Use this method when your agent is behind a reverse proxy, load balancer, or tunnel and the auto-detected URL does not match the external address.

You can also set the SWML_PROXY_URL_BASE environment variable to override the base URL globally without calling this method.

Parameters

url

stringRequired

The full URL that SignalWire should use to reach this agent’s SWAIG endpoints.

Returns

AgentBase — Returns this for method chaining.

Example

1 import { AgentBase } from '@signalwire/sdk';
2 
3 const agent = new AgentBase({ name: 'support', route: '/support' });
4 agent.setPromptText('You are a helpful assistant.');
5 // Agent is behind ngrok
6 agent.setWebHookUrl('https://abc123.ngrok.io/support');
7 await agent.serve();

1	import { AgentBase } from '@signalwire/sdk';
2
3	const agent = new AgentBase({ name: 'support', route: '/support' });
4	agent.setPromptText('You are a helpful assistant.');
5	// Agent is behind ngrok
6	agent.setWebHookUrl('https://abc123.ngrok.io/support');
7	await agent.serve();