getWebHooks

get

/ccadmin/v1/webhooks

Get Web Hooks. Gets an array of webhooks.Response can be narrowed by a "serverType parameter". Each element of the returned array follows the format of that returned by getWebHook.

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getWebHooks_response
Type: object
Show Source
Nested Schema : basicAuthentication
Type: object
Map of username and password
Show Source
Nested Schema : headers
Type: object
Map of header names and header values
Show Source
Nested Schema : urls
Type: array
An array of strings of the target URLs for the WebHook.
Show Source
Example Response (application/json)
[
    {
        "maxNumberOfResendAttempts":"5",
        "resendDelaySeconds":"3600",
        "headers":{
            "header1":"value1"
        },
        "urls":null,
        "secretKey":null,
        "displayName":"atg.service.webhook.Resources->webHookDisplayName_submitOrder",
        "serverType":"production",
        "name":"submitOrder",
        "id":"production-submitOrder",
        "applyResendDelayToFirstAttempt":"true",
        "basicAuthentication":{
            "admin":"admin"
        }
    },
    {
        "maxNumberOfResendAttempts":"5",
        "resendDelaySeconds":"3600",
        "headers":null,
        "urls":null,
        "secretKey":null,
        "displayName":"atg.service.webhook.Resources->webHookDisplayName_publishEvent",
        "serverType":"production",
        "name":"publishEvent",
        "id":"production-publishEvent",
        "applyResendDelayToFirstAttempt":"true",
        "basicAuthentication":null
    },
    {
        "maxNumberOfResendAttempts":"5",
        "resendDelaySeconds":"3600",
        "headers":null,
        "urls":null,
        "secretKey":null,
        "displayName":"atg.service.webhook.Resources->webHookDisplayName_submitOrder",
        "serverType":"publishing",
        "name":"submitOrder",
        "id":"publishing-submitOrder",
        "applyResendDelayToFirstAttempt":"true",
        "basicAuthentication":null
    },
    {
        "maxNumberOfResendAttempts":"5",
        "resendDelaySeconds":"3600",
        "headers":null,
        "urls":null,
        "secretKey":null,
        "displayName":"atg.service.webhook.Resources->webHookDisplayName_publishEvent",
        "serverType":"publishing",
        "name":"publishEvent",
        "id":"publishing-publishEvent",
        "applyResendDelayToFirstAttempt":"true",
        "basicAuthentication":null
    }
]

Default Response

The error response
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top