Create cXML webhook

POST

https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_webhooks

POST

/api/fabric/resources/cxml_webhooks

curl -X POST https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_webhooks \
     -H "Content-Type: application/json" \
     -u "<project_id>:<api_token>" \
     -d '{
  "primary_request_url": "https://primary.com"
}'

{
  "id": "a87db7ed-8ebe-42e4-829f-8ba5a4152f54",
  "project_id": "99151cf8-9548-4860-ba70-a8de824f3312",
  "display_name": "Booking Assistant",
  "type": "cxml_webhook",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "cxml_webhook": {
    "id": "a87db7ed-8ebe-42e4-829f-8ba5a4152f54",
    "name": "My CXML Webhook",
    "used_for": "calling",
    "primary_request_url": "https://primary.com",
    "primary_request_method": "GET",
    "fallback_request_url": "https://fallback.com",
    "fallback_request_method": "GET",
    "status_callback_url": "https://callback.com",
    "status_callback_method": "POST"
  }
}

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.

used_forenumOptionalDefaults to calling

Used for of the CXML Webhook.

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:

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

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error