updateFunctionWebHooks

put

/ccadmin/v1/functionWebhooks

Update Function Web Hooks. Update existing WebHooks.

Request

Supported Media Types
Body ()
Root Schema : updateFunctionWebHooks_request
Type: object
Show Source
Example:
{
    "webHooks":[
        {
            "headers":null,
            "synchronousRetries":0,
            "secretKey":null,
            "displayName":"atg.service.webhook.Resources->webHookDisplayName_publishEvent",
            "serverType":"production",
            "name":"calculateShipping",
            "id":"production-calculateShipping",
            "url":null
        },
        {
            "headers":{
                "header1":"value1"
            },
            "synchronousRetries":5,
            "displayName":"Calculate Shipping - Publishing",
            "serverType":"publishing",
            "name":"calculateShipping",
            "id":"publishing-calculateShipping",
            "basicAuthentication":{
                "admin":"admin123"
            },
            "url":"https://localhost:8080/calculateShipping"
        }
    ]
}
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
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateFunctionWebHooks_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
Example Response (application/json)
[
    {
        "headers":null,
        "synchronousRetries":0,
        "secretKey":null,
        "supportsSynchronousRetry":false,
        "displayName":"Calculate Shipping - Production",
        "serverType":"production",
        "name":"calculateShipping",
        "id":"production-calculateShipping",
        "url":null
    },
    {
        "headers":{
            "header1":"value1"
        },
        "synchronousRetries":0,
        "supportsSynchronousRetry":false,
        "displayName":"Calculate Shipping - Publishing",
        "serverType":"publishing",
        "name":"calculateShipping",
        "id":"publishing-calculateShipping",
        "basicAuthentication":{
            "admin":"admin123"
        },
        "url":"https://localhost:8080/calculateShipping"
    }
]

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