Get External SWML Handler

GET 
/resources/external_swml_handlers/:id

Returns an External SWML Handler by ID

Request

Path Parameters

id uuidrequired

Unique ID of a External SWML Handler.

Responses

200

The request has succeeded.

application/json

Schema

Schema

iduuidrequired

Universal Unique Identifier.

namestringrequired
Name of the External SWML Handler.
Example: My External SWML Handler
used_forstringrequired
Used for of the External SWML Handler.
Possible values: [calling]
Example: calling
primary_request_urlstringrequired
Primary request url of the External SWML Handler.
Example: https://primary.com
primary_request_methodUrlMethodType (string)required

The method type to use for the URL

Possible values: [GET, POST]

fallback_request_urlstringrequired
Fallback request url of the External SWML Handler.
Example: https://fallback.com
fallback_request_methodUrlMethodType (string)required

The method type to use for the URL

Possible values: [GET, POST]

status_callback_urlstringrequired
Status callback url of the External SWML Handler.
Example: https://callback.com
status_callback_methodUrlMethodType (string)required

The method type to use for the URL

Possible values: [GET, POST]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "My External SWML Handler",
  "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": "GET"
}

401

Access is unauthorized.

application/json

Schema

Schema

string

Possible values: [Unauthorized]

404

The server cannot find the requested resource.

application/json

Schema

Schema

string

Possible values: [Not Found]