Skip to navigation

List cXML webhook resources in the project.

Response

datalist of objectsRequired
An array of objects containing a list of cXML Webhook data

Response Example

Response
{
"data": [
{
"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",
"script_type": "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",
"used_for": "calling"
}
}
],
"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"
}
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
project: "your-project-id",
token: "your-api-token",
host: "your-space.signalwire.com",
});
const response = await client.fabric.cxmlWebhooks.list();
for (const webhook of response.data ?? []) {
console.log(`${webhook.display_name}: ${webhook.id}`);
}