v77

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012528701.8 MB

SWML Webhook

SWML inbound message webhook

Payload sent by SignalWire to a SWML messaging webhook URL when an inbound SMS or MMS message arrives on a phone number configured with a SWML message handler. The same payload shape is also used when the SWML messaging transfer method targets an external URL — in that case, params carries the values supplied to the transfer step and vars carries the propagated runtime variables from the originating document.

The webhook URL is expected to respond with the SWML document to execute for the inbound message.

postWebhookinboundMessageWebhook

Payload

varsobject

Script-scope variables propagated from the SWML document that issued a transfer step. Absent on the initial inbound-message fetch; present (possibly empty) on fetches driven by a transfer step inside a full-mode SWML document. Common keys include request_result, request_response, request_response_code, request_response_body, reply_result, and reply_message_id.

paramsobject required

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

Example payload

{
  "message": {
    "message_id": "c2d3e4f5-a6b7-8901-cdef-234567890abc",
    "project_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "space_id": "d3e4f5a6-b7c8-9012-defa-345678901bcd",
    "direction": "inbound",
    "type": "sms",
    "from": "+15551231234",
    "to": "+15553214321",
    "body": "Hello, I need help",
    "media": [],
    "segments": 1,
    "timestamp": "2024-01-15T10:30:00Z"
  },
  "vars": {
    "request_result": "success",
    "reply_result": "queued"
  },
  "params": {}
}

Response

Webhook received