Resource ManagementcXML Webhook

Update cXML webhook

View as MarkdownOpen in Claude
Updates an cXML Webhook by ID #### 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](/docs/platform/your-signalwire-api-space).

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.

Request

This endpoint expects an object.
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

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
422
Unprocessable Entity Error
500
Internal Server Error