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,
            "subEntityTruncationSize":null,
            "secretKey512":null,
            "synchronousRetries":0,
            "secretKey":null,
            "urlApplicationSuppressionList":[
                {
                    "url":"https://example.com",
                    "applications":[
                        "applicationId1"
                    ]
                }
            ],
            "displayName":"atg.service.webhook.Resources->webHookDisplayName_publishEvent",
            "serverType":"production",
            "name":"calculateShipping",
            "id":"production-calculateShipping",
            "url":null
        },
        {
            "headers":{
                "header1":"value1"
            },
            "subEntityTruncationSize":null,
            "synchronousRetries":5,
            "urlApplicationSuppressionList":[
                {
                    "url":"https://example.com",
                    "applications":[
                        "applicationId1"
                    ]
                }
            ],
            "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
Nested Schema : urlApplicationSuppressionList
Type: array
Array of URL - Applications suppression. Each object contains a URL to be suppressed and an array of application Ids (using /ccadmin/v1/applicationIds endpoint) for which the URL needs to be suppressed when the application calls OCC endpoint to create or update an entity.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : applications
Type: array
Array of strings representing application Ids, events triggered by which should suppress the URL.
Show Source
  • Id of the registered application. Refer to /ccadmin/v1/applicationIds for more details.
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
  • basicAuthentication
    Map of username and password
  • The display name of the WebHook.
  • headers
    Map of header names and header values
  • WebHook identifier.
  • The simple name of the WebHook.
  • The base64 encoded SHA1 secret key of the WebHook. Will be null unless includeSecretKeys query parameter is true. A secret key is currently shared between WebHooks of the same name (like "calculateShipping"). The secret key will have a non-null value only if the authentication method was previously chosen as secret key.
  • The base64 encoded SHA512 secret key of the WebHook. Will be null unless includeSecretKeys query parameter is true. A secret key is currently shared between WebHooks of the same name (like "calculateShipping"). The secret key will have a non-null value only if the authentication method was previously chosen as secret key.
  • The server type of the WebHook.
  • Threshold at which some of the sub-entities in Webhook payload, like cart items, return items and addresses get truncated when number of records exceeds configured threshold size (allowed range is 100-50000). For more details on which sub-entities get truncated for a Webhook, refer to individual Webhook payload document
  • True if synchronous retries are enabled. Read-only.
  • The maximum number of times the WebHook should be retried if it returns an error.
  • The target URL for the function WebHook.
  • urlApplicationSuppressionList
    Array of URL - Applications suppression. Each object contains a URL to be suppressed and an array of application Ids (using /ccadmin/v1/applicationIds endpoint) for which the URL needs to be suppressed when the application calls OCC endpoint to create or update an entity.
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 : urlApplicationSuppressionList
Type: array
Array of URL - Applications suppression. Each object contains a URL to be suppressed and an array of application Ids (using /ccadmin/v1/applicationIds endpoint) for which the URL needs to be suppressed when the application calls OCC endpoint to create or update an entity.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : applications
Type: array
Array of strings representing application Ids, events triggered by which should suppress the URL.
Show Source
  • Id of the registered application. Refer to /ccadmin/v1/applicationIds for more details.
Example Response (application/json)
[
    {
        "headers":null,
        "subEntityTruncationSize":null,
        "synchronousRetries":0,
        "secretKey":null,
        "urlApplicationSuppressionList":[
            {
                "url":"https://example.com",
                "applications":[
                    "applicationId1"
                ]
            }
        ],
        "supportsSynchronousRetry":false,
        "displayName":"Calculate Shipping - Production",
        "serverType":"production",
        "name":"calculateShipping",
        "id":"production-calculateShipping",
        "url":null,
        "secretKeySHA512":null
    },
    {
        "headers":{
            "header1":"value1"
        },
        "subEntityTruncationSize":null,
        "synchronousRetries":0,
        "urlApplicationSuppressionList":[
            {
                "url":"https://example.com",
                "applications":[
                    "applicationId1"
                ]
            }
        ],
        "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