Get cXML webhook

GET

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

GET

/api/fabric/resources/cxml_webhooks/:id

curl https://{your_space_name}.signalwire.com/api/fabric/resources/cxml_webhooks/id \
     -u "<project_id>:<api_token>"

{
  "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"
  }
}

Retrieves one cXML Webhook by resource ID so you can inspect the server-backed handler. Use List cXML webhooks to discover IDs, or a cXML Script for cXML stored in SignalWire.

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)

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a CXML Webhook.

Response

The request has succeeded.

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

500

Internal Server Error