updateFunctionWebHook

put

/ccadmin/v1/functionWebhooks/{id}

Update Function Web Hook. Update a single existing function WebHook based on given ID and request parameters.

Request

Supported Media Types
Path Parameters
  • ID corresponding to the WebHook which is to be updated.
Body ()
Root Schema : updateFunctionWebHook_request
Type: object
Show Source
Example:
{
    "headers":{
        "header1":"value1"
    },
    "synchronousRetries":5,
    "displayName":"Calculate Shipping - Production",
    "serverType":"production",
    "name":"calculateShipping",
    "id":"production-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 : updateFunctionWebHook_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":{
        "header1":"value1"
    },
    "synchronousRetries":0,
    "supportsSynchronousRetry":false,
    "displayName":"Calculate Shipping - Production",
    "serverType":"production",
    "name":"calculateShipping",
    "id":"production-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