List SWML webhooks

GET

https://{your_space_name}.signalwire.com/api/fabric/resources/swml_webhooks

GET

/api/fabric/resources/swml_webhooks

curl https://{your_space_name}.signalwire.com/api/fabric/resources/swml_webhooks \
     -u "<project_id>:<api_token>"

{
  "data": [
    {
      "id": "a87db7ed-8ebe-42e4-829f-8ba5a4152f54",
      "project_id": "99151cf8-9548-4860-ba70-a8de824f3312",
      "display_name": "Booking Assistant",
      "type": "swml_webhook",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:20:00Z",
      "swml_webhook": {
        "id": "a87db7ed-8ebe-42e4-829f-8ba5a4152f54",
        "name": "My SWML 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"
      }
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/swml_webhooks?page_number=0&page_size=50&type=swml_webhook",
    "first": "https://example.signalwire.com/api/fabric/resources/swml_webhooks?page_number=0&page_size=50&type=swml_webhook",
    "next": "https://example.signalwire.com/api/fabric/resources/swml_webhooks?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=swml_webhook",
    "prev": "https://example.signalwire.com/api/fabric/resources/swml_webhooks?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=swml_webhook"
  }
}

Returns the project’s SWML Webhook resources, whose configured servers return calling or messaging SWML for each request. Use it to discover dynamic SWML handlers before retrieving or changing one. Use SWML Scripts when the SWML 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.

Returns the project's SWML Webhook resources, whose configured servers return calling or messaging SWML for each request. Use it to discover dynamic SWML handlers before retrieving or changing one. Use [SWML Scripts](/docs/apis/rest/swml-scripts/list-swml-scripts) when the SWML 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](/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)

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) ```

Response

The request has succeeded.

datalist of objects

An array of objects that contain a list of SWML Webhook data

linksobject

Object containing pagination links

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error