Resource ManagementSWML Webhook

Create SWML webhook

View as MarkdownOpen in Claude
Creates an SWML Webhook #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Request

This endpoint expects an object.
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; for messaging, see the SWML 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 or SWML 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 webhook for the payload your URL will receive.

status_callback_methodenumOptionalDefaults to POST
Status callback method of the SWML Webhook.
Allowed values:

Response

The request has succeeded and a new resource has been created as a result.
idstringformat: "uuid"
Unique ID of the SWML Webhook.
project_idstringformat: "uuid"
Unique ID of the Project.
display_namestring
Display name of the SWML Webhook Fabric Resource
typeenum
Type of the Fabric Resource
Allowed values:
created_atdatetime
Date and time when the resource was created.
updated_atdatetime
Date and time when the resource was updated.
swml_webhookobject
SWML Webhook data.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error