SWML Webhook

List SWML webhook Addresses

Returns the project-scoped resource addresses assigned to one SWML Webhook. Use these callable handles to see how calls or messages can reach the server-backed SWML handler; use List SWML webhooks for the resources themselves, or the SWML Script address operation for stored SWML handlers.

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.

get/api/fabric/resources/swml_webhooks/{swml_webhook_id}/addresses

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/fabric/resources/swml_webhooks/{swml_webhook_id}/addresses
  • Auth
    HTTP basic

Path parameters

swml_webhook_idstring uuid required

Universal Unique Identifier.

Unique ID of a SWML Webhook.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "name": "justice-league",
      "display_name": "Justice League",
      "cover_url": "https://coverurl.com",
      "preview_url": "https://previewurl.com",
      "locked": true,
      "channels": {
        "audio": "/external/resource_name?channel=audio"
      },
      "created_at": "2024-05-06T12:20:00Z",
      "type": "app"
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/swml_webhooks/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&type=swml_webhook",
    "first": "https://example.signalwire.com/api/fabric/resources/swml_webhooks/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&type=swml_webhook",
    "next": "https://example.signalwire.com/api/fabric/resources/swml_webhooks/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?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/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=swml_webhook"
  }
}

Changes

No operation changes found yet. Some revisions have not been checked.