> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt

# get

> Retrieve a single cXML webhook resource.

Retrieve a single cXML webhook resource.

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /api/fabric/resources/cxml_webhooks/{id}:
    get:
      operationId: get_cxml_webhook
      summary: Get cXML webhook
      description: >-
        Returns 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).
      tags:
        - subpackage_cXmlWebhook
      parameters:
        - name: id
          in: path
          description: Unique ID of a CXML Webhook.
          required: true
          schema:
            $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CXMLWebhookResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com
    description: SignalWire API
components:
  schemas:
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    CxmlWebhookResponseType:
      type: string
      enum:
        - cxml_webhook
      description: Type of the Fabric Resource
      title: CxmlWebhookResponseType
    UsedForType:
      type: string
      enum:
        - calling
        - messaging
      description: Sets the handler to handle incoming `calls` or `messages`.
      title: UsedForType
    RequestUrlMethodType:
      type: string
      enum:
        - GET
        - POST
      description: The method type to use for the URL
      title: RequestUrlMethodType
    CXMLWebhook:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the CXML Webhook.
        name:
          type: string
          description: Name of the CXML Webhook.
        used_for:
          $ref: '#/components/schemas/UsedForType'
          description: Used for of the CXML Webhook.
        primary_request_url:
          type: string
          format: uri
          description: Primary request url of the CXML Webhook.
        primary_request_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: Primary request method of the CXML Webhook.
        fallback_request_url:
          type:
            - string
            - 'null'
          format: uri
          description: Fallback request url of the CXML Webhook.
        fallback_request_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: Fallback request method of the CXML Webhook.
        status_callback_url:
          type:
            - string
            - 'null'
          format: uri
          description: Status callback url of the CXML Webhook.
        status_callback_method:
          $ref: '#/components/schemas/RequestUrlMethodType'
          description: Status callback method of the CXML Webhook.
      required:
        - id
        - name
        - used_for
        - primary_request_url
        - primary_request_method
        - fallback_request_url
        - fallback_request_method
        - status_callback_url
        - status_callback_method
      title: CXMLWebhook
    CXMLWebhookResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the CXMLWebhook.
        project_id:
          $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
        display_name:
          type: string
          description: Display name of the CXMLWebhook Fabric Resource
        type:
          $ref: '#/components/schemas/CxmlWebhookResponseType'
          description: Type of the Fabric Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
        cxml_webhook:
          $ref: '#/components/schemas/CXMLWebhook'
          description: CXMLWebhook data.
      required:
        - id
        - project_id
        - display_name
        - type
        - created_at
        - updated_at
        - cxml_webhook
      title: CXMLWebhookResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode404Error:
      type: string
      enum:
        - Not Found
      title: TypesStatusCodesStatusCode404Error
    Types.StatusCodes.StatusCode404:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error'
      required:
        - error
      description: The server cannot find the requested resource.
      title: Types.StatusCodes.StatusCode404
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500

```

## **Response Example**

### Response (200)

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

## **Example**

```typescript {9}
import { RestClient } from "@signalwire/sdk";

const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com",
});

const webhook = await client.fabric.cxmlWebhooks.get("webhook-id");
console.log("Cxml Webhook:", webhook.display_name, "ID:", webhook.id);
```