Skip to navigation
Resource ManagementcXML Webhook

Create cXML webhook

View as MarkdownOpen in Claude

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.

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 request url of the CXML Webhook.
namestringOptional
Name of the CXML Webhook.
script_typeenumOptionalDefaults to calling
Whether this CXML Webhook handles calls, messages, or faxes.
Allowed values:
primary_request_methodenumOptionalDefaults to POST
Primary request method of the CXML Webhook.
Allowed values:
fallback_request_urlstringOptionalformat: "uri"
Fallback request url of the CXML Webhook.
fallback_request_methodenumOptionalDefaults to POST
Fallback request method of the CXML Webhook.
Allowed values:
status_callback_urlstringOptionalformat: "uri"
Status callback url of the CXML Webhook.
status_callback_methodenumOptionalDefaults to POST
Status callback method of the CXML Webhook.
Allowed values:
used_forenumOptionalDeprecated

Deprecated. Use script_type. Read only when script_type is not sent.

Allowed values:

Response

The request has succeeded and a new resource has been created as a result.
idstringformat: "uuid"
Unique ID of the CXMLWebhook.
project_idstringformat: "uuid"
Unique ID of the Project.
display_namestring
Display name of the CXMLWebhook 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.
cxml_webhookobject
CXMLWebhook data.

Errors

422
Unprocessable Entity Error
500
Internal Server Error