REST ClientFabricSWML Webhooks

create

View as MarkdownOpen in Claude

Create a new SWML webhook resource.

Request

primary_request_urlstringRequiredformat: "uri"
Primary URL SignalWire fetches the SWML document from when the webhook fires. The webhook payload depends on `used_for`: for `calling`, see the [SWML inbound call webhook](/docs/apis/rest/swml-webhook/webhooks/inbound-call-webhook); for `messaging`, see the [SWML inbound message webhook](/docs/apis/rest/swml-webhook/webhooks/inbound-message-webhook).
namestringOptional
Name of the SWML Webhook.
used_forenumOptionalDefaults to calling
Indicates whether this SWML Webhook handles inbound calls or inbound messages. Determines the payload SignalWire POSTs to `primary_request_url`.
Allowed values:
primary_request_methodenumOptionalDefaults to POST
Primary request method of the SWML Webhook.
Allowed values:
fallback_request_urlstringOptionalformat: "uri"
Fallback URL SignalWire fetches the SWML document from if the primary URL fails. Receives the same payload as `primary_request_url` — see the [SWML inbound call webhook](/docs/apis/rest/swml-webhook/webhooks/inbound-call-webhook) or [SWML inbound message webhook](/docs/apis/rest/swml-webhook/webhooks/inbound-message-webhook) depending on `used_for`.
fallback_request_methodenumOptionalDefaults to POST
Fallback request method of the SWML Webhook.
Allowed values:
status_callback_urlstringOptionalformat: "uri"
URL to receive message status callback events for outbound messages sent by this webhook (`reply` or `send_sms`). See the [Message status callback](/docs/apis/rest/messages/webhooks/message-status-callback) webhook for the payload your URL will receive.
status_callback_methodenumOptionalDefaults to POST
Status callback method of the SWML Webhook.
Allowed values:

Response

idstringRequiredformat: "uuid"
Unique ID of the SWML Webhook.
project_idstringRequiredformat: "uuid"
Unique ID of the Project.
display_namestringRequired
Display name of the SWML Webhook Fabric Resource
typeenumRequired
Type of the Fabric Resource
Allowed values:
created_atdatetimeRequired
Date and time when the resource was created.
updated_atdatetimeRequired
Date and time when the resource was updated.
swml_webhookobjectRequired
SWML Webhook data.

Response Example

Response
1{
2  "id": "a87db7ed-8ebe-42e4-829f-8ba5a4152f54",
3  "project_id": "99151cf8-9548-4860-ba70-a8de824f3312",
4  "display_name": "Booking Assistant",
5  "type": "swml_webhook",
6  "created_at": "2024-05-06T12:20:00Z",
7  "updated_at": "2024-05-06T12:20:00Z",
8  "swml_webhook": {
9    "id": "a87db7ed-8ebe-42e4-829f-8ba5a4152f54",
10    "name": "My SWML Webhook",
11    "used_for": "calling",
12    "primary_request_url": "https://primary.com",
13    "primary_request_method": "GET",
14    "fallback_request_url": "https://fallback.com",
15    "fallback_request_method": "GET",
16    "status_callback_url": "https://callback.com",
17    "status_callback_method": "POST"
18  }
19}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4    project="your-project-id",
5    token="your-api-token",
6    host="your-space.signalwire.com",
7)
8
9result = client.fabric.swml_webhooks.create(
10    name="my-webhook", primary_request_url="https://example.com/swml",
11)
12print(f"Created: {result['id']}")