AI sidecar SWAIG tool webhook

Sent to a sidecar tool’s web_hook_url (or the SWAIG defaults.web_hook_url) when the sidecar calls one of your functions. Your endpoint runs the function and returns a JSON object with a response string (the result the model reads next) and, optionally, an action — a single object or an array — telling the sidecar what to do. See Supported SWAIG actions for what you can return.

The sidecar only listens to the call and never speaks on it, so a say action is reported back to you as a callback rather than being spoken aloud.

Sent to a sidecar tool's `web_hook_url` (or the SWAIG `defaults.web_hook_url`) when the sidecar calls one of your functions. Your endpoint runs the function and returns a JSON object with a `response` string (the result the model reads next) and, optionally, an `action` — a single object or an array — telling the sidecar what to do. See [Supported SWAIG actions](/docs/swml/reference/calling/ai-sidecar#supported-swaig-actions) for what you can return. The sidecar only listens to the call and never speaks on it, so a `say` action is reported back to you as a callback rather than being spoken aloud.

Payload

The payload of this webhook request is an object.

functionstringRequired

The name of the function the model is calling.

argumentobjectRequired

The arguments the model passed to your function.

call_idstringRequired

The ID of the call the sidecar is attached to.

channel_dataobjectRequired

Call/channel context.

global_dataobjectOptional

The sidecar’s current global_data. Present when the sidecar has any.

Response

200

Webhook received

1	{
2	"function": "lookup_competitor",
3	"argument": {
4	"parsed": [
5	{
6	"competitor": "ACME"
7	}
8	],
9	"raw": "{\"competitor\":\"ACME\"}",
10	"substituted": "{\"competitor\":\"ACME\"}"
11	},
12	"call_id": "2e1e66e5-5d07-413d-9668-55542992eec0",
13	"channel_data": {
14	"call_id": "2e1e66e5-5d07-413d-9668-55542992eec0"
15	}
16	}