AI Webhooks
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 replies with a JSON object. Both fields are optional, so {} is a valid reply:
- response — the result the model reads next. A plain string only; the {tool_result, tool_prompt} object form that ai agents accept is not read. Omit it and the model reads a default result.
- action — a single action object or an array of them. See Supported SWAIG actions for what you can return.
There is no post_process on a sidecar reply.
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.
postWebhookaiSidecarSwaigToolWebhook
Payload
Example payload
{
"function": "lookup_competitor",
"argument": {
"parsed": [
{
"competitor": "ACME"
}
],
"raw": "{\"competitor\":\"ACME\"}"
},
"call_id": "2e1e66e5-5d07-413d-9668-55542992eec0",
"channel_data": {
"call_id": "2e1e66e5-5d07-413d-9668-55542992eec0",
"caller_id_name": "Jane Doe",
"caller_id_number": "+15555550100",
"destination_number": "+15555550199"
}
}Response
Webhook received