SIsignalwire
cXML Webhook

Create cXML webhook

Creates a resource that requests cXML from your server when the handler runs. Use it when call or message instructions depend on current application state; use Create cXML Script when the cXML can be stored in SignalWire, or Create SWML webhook when the server returns SWML.

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.

post/api/fabric/resources/cxml_webhooks

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/fabric/resources/cxml_webhooks
  • Auth
    HTTP basic

Request body

namestring

Name of the CXML Webhook.

used_for'calling' | 'messaging'

Sets the handler to handle incoming calls or messages.

primary_request_urlstring uri required

Primary request url of the CXML Webhook.

primary_request_method'GET' | 'POST'

The method type to use for the URL

fallback_request_urlstring uri

Fallback request url of the CXML Webhook.

fallback_request_method'GET' | 'POST'

The method type to use for the URL

status_callback_urlstring uri

Status callback url of the CXML Webhook.

status_callback_method'GET' | 'POST'

The method type to use for the URL

Example request

{
  "name": "My CXML Webhook",
  "primary_request_url": "https://primary.com",
  "fallback_request_url": "https://fallback.com",
  "status_callback_url": "https://callback.com"
}

Response

The request has succeeded and a new resource has been created as a result.

idstring uuid required

Universal Unique Identifier.

project_idstring uuid required

Universal Unique Identifier.

display_namestring required

Display name of the CXMLWebhook Fabric Resource

type'cxml_webhook' required

Type of the Fabric Resource

created_atstring date-time required

Date and time when the resource was created.

updated_atstring date-time required

Date and time when the resource was updated.

Example response

{
  "display_name": "Booking Assistant",
  "type": "cxml_webhook",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "cxml_webhook": {
    "name": "My CXML Webhook",
    "primary_request_url": "https://primary.com",
    "fallback_request_url": "https://fallback.com",
    "status_callback_url": "https://callback.com"
  }
}

Changes

No operation changes found yet. Some revisions have not been checked.