cXML Webhook

List cXML webhooks

Returns the project's cXML Webhook resources, whose configured servers return cXML for each request. Use it to discover server-backed cXML handlers before retrieving or changing one. Use cXML Scripts when the cXML should be stored in SignalWire instead.

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.

get/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

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "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"
      }
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/cxml_webhooks?page_number=0&page_size=50&type=cxml_webhook",
    "first": "https://example.signalwire.com/api/fabric/resources/cxml_webhooks?page_number=0&page_size=50&type=cxml_webhook",
    "next": "https://example.signalwire.com/api/fabric/resources/cxml_webhooks?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=cxml_webhook",
    "prev": "https://example.signalwire.com/api/fabric/resources/cxml_webhooks?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=cxml_webhook"
  }
}

Changes