REST ClientFabriccXML Webhooks

update

View as MarkdownOpen in Claude

Partially update a cXML webhook resource. Uses PATCH for partial.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a CXML Webhook.

Request

namestringOptional
Name of the CXML Webhook.
used_forenumOptional
Used for of the CXML Webhook.
Allowed values:
primary_request_urlstringOptionalformat: "uri"
Primary request url of the CXML Webhook.
primary_request_methodenumOptional
Primary request method of the CXML Webhook.
fallback_request_urlstringOptionalformat: "uri"
Fallback request url of the CXML Webhook.
fallback_request_methodenumOptional
Fallback request method of the CXML Webhook.
status_callback_urlstringOptionalformat: "uri"
Status callback url of the CXML Webhook.
status_callback_methodenumOptional
Status callback method of the CXML Webhook.

Response

idstringRequiredformat: "uuid"
Unique ID of the CXMLWebhook.
project_idstringRequiredformat: "uuid"
Unique ID of the Project.
display_namestringRequired
Display name of the CXMLWebhook Fabric Resource
typeenumRequired
Type of the Fabric Resource
Allowed values:
created_atdatetimeRequired
Date and time when the resource was created.
updated_atdatetimeRequired
Date and time when the resource was updated.
cxml_webhookobjectRequired
CXMLWebhook data.

Response Example

Response
1{
2  "id": "a87db7ed-8ebe-42e4-829f-8ba5a4152f54",
3  "project_id": "99151cf8-9548-4860-ba70-a8de824f3312",
4  "display_name": "Booking Assistant",
5  "type": "cxml_webhook",
6  "created_at": "2024-05-06T12:20:00Z",
7  "updated_at": "2024-05-06T12:20:00Z",
8  "cxml_webhook": {
9    "id": "a87db7ed-8ebe-42e4-829f-8ba5a4152f54",
10    "name": "My CXML Webhook",
11    "used_for": "calling",
12    "primary_request_url": "https://primary.com",
13    "primary_request_method": "GET",
14    "fallback_request_url": "https://fallback.com",
15    "fallback_request_method": "GET",
16    "status_callback_url": "https://callback.com",
17    "status_callback_method": "POST"
18  }
19}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com",
7});
8
9const updated = await client.fabric.cxmlWebhooks.update("webhook-id", {
10  name: "updated-name",
11});
12console.log("Updated:", updated.display_name);