Resource ManagementSWML WebhookWebhooks

SWML inbound call webhook

View as MarkdownOpen in Claude
Payload sent by SignalWire to a SWML calling webhook URL when SWML is fetched for a call. This includes inbound calls arriving on a phone number configured with a SWML calling handler, and outbound REST-initiated calls that point at a SWML URL. The same payload shape is also used when the SWML calling `transfer` or `execute` method targets an external URL — in those cases, the `params` object carries the values supplied to that step. The webhook URL is expected to respond with the SWML document to execute for the call.

Payload

The payload of this webhook request is an object.
callobjectRequired
The call that triggered this fetch.
varsobjectRequired

Script-scope variables for this call session. Empty on the initial document fetch.

envsobjectRequired
Environment variables configured at the account or project level.
paramsobjectRequired

Parameters passed via a SWML calling execute or transfer step. An empty object on the initial document fetch.

Response

200
Webhook received