REST API for Oracle Commerce Cloud 21B

updateWebHooks

put

/ccadmin/v1/webhooks

Update Web Hooks. Update existing WebHooks.

Request

Supported Media Types

application/json

Root Schema : updateWebHooks_request

Type: object

Show Source

applyResendDelayToFirstAttempt(optional): boolean

Apply resend delay in first attempt
basicAuthentication(optional): object basicAuthentication

Map of username and password
displayName(optional): integer

The display name of the WebHook.
headers(optional): object headers

Map of header names and header values
id: integer

WebHook identifier.
includeChangesOnly(optional): boolean

The webhook payload will include only the changes for list and map properties when this value is set as true
maxNumberOfResendAttempts(optional): integer

Max number of resend attempts
name(optional): integer

The simple name of the WebHook.
resendDelaySeconds(optional): integer

Resend delay in seconds
secretKey(optional): integer

The base64 encoded 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 "submitOrder").
serverType(optional): integer

The server type of the WebHook.
subEntityTruncationSize(optional): integer

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
urlApplicationSuppressionList(optional): array 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.
urls(optional): array urls

An array of strings of the target URLs for the WebHook.

{
    "properties":{
        "headers":{
            "description":"Map of header names and header values",
            "type":"object",
            "properties":{
                "headerName":{
                    "description":"The header name.",
                    "type":"string"
                },
                "headerValue":{
                    "description":"The header value.",
                    "type":"string"
                }
            }
        },
        "resendDelaySeconds":{
            "description":"Resend delay in seconds",
            "type":"integer"
        },
        "includeChangesOnly":{
            "description":"The webhook payload will include only the changes for list and map properties when this value is set as true",
            "type":"boolean"
        },
        "secretKey":{
            "description":"The base64 encoded 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 \"submitOrder\").",
            "type":"integer"
        },
        "urlApplicationSuppressionList":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "url":{
                        "description":"The URL to be suppressed.",
                        "type":"string"
                    },
                    "applications":{
                        "description":"Array of strings representing application Ids, events triggered by which should suppress the URL.",
                        "type":"array",
                        "items":{
                            "description":"Id of the registered application. Refer to /ccadmin/v1/applicationIds for more details.",
                            "type":"string"
                        }
                    }
                }
            }
        },
        "displayName":{
            "description":"The display name of the WebHook.",
            "type":"integer"
        },
        "basicAuthentication":{
            "description":"Map of username and password",
            "type":"object",
            "properties":{
                "password":{
                    "description":"The password.",
                    "type":"string"
                },
                "username":{
                    "description":"The user name.",
                    "type":"string"
                }
            }
        },
        "maxNumberOfResendAttempts":{
            "description":"Max number of resend attempts",
            "type":"integer"
        },
        "subEntityTruncationSize":{
            "description":"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",
            "type":"integer"
        },
        "urls":{
            "description":"An array of strings of the target URLs for the WebHook.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "serverType":{
            "description":"The server type of the WebHook.",
            "type":"integer"
        },
        "name":{
            "description":"The simple name of the WebHook.",
            "type":"integer"
        },
        "id":{
            "description":"WebHook identifier.",
            "type":"integer"
        },
        "applyResendDelayToFirstAttempt":{
            "description":"Apply resend delay in first attempt",
            "type":"boolean"
        }
    },
    "required":[
        "id"
    ],
    "example":{
        "webHooks":[
            {
                "headers":null,
                "subEntityTruncationSize":null,
                "urls":null,
                "includeChangesOnly":false,
                "secretKey":null,
                "urlApplicationSuppressionList":[
                    {
                        "url":"https://example.com",
                        "applications":[
                            "applicationId1"
                        ]
                    }
                ],
                "displayName":"atg.service.webhook.Resources->webHookDisplayName_publishEvent",
                "serverType":"production",
                "name":"publishEvent",
                "id":"production-publishEvent"
            },
            {
                "headers":{
                    "header1":"value1"
                },
                "subEntityTruncationSize":null,
                "urls":[
                    "https://localhost:8080/submitOrder"
                ],
                "includeChangesOnly":false,
                "urlApplicationSuppressionList":[
                    {
                        "url":"https://example.com",
                        "applications":[
                            "applicationId1"
                        ]
                    }
                ],
                "displayName":"atg.service.webhook.Resources->webHookDisplayName_submitOrder",
                "serverType":"production",
                "name":"submitOrder",
                "id":"production-submitOrder",
                "basicAuthentication":{
                    "admin":"admin123"
                }
            }
        ]
    }
}

Example:

{
    "webHooks":[
        {
            "headers":null,
            "subEntityTruncationSize":null,
            "urls":null,
            "includeChangesOnly":false,
            "secretKey":null,
            "urlApplicationSuppressionList":[
                {
                    "url":"https://example.com",
                    "applications":[
                        "applicationId1"
                    ]
                }
            ],
            "displayName":"atg.service.webhook.Resources->webHookDisplayName_publishEvent",
            "serverType":"production",
            "name":"publishEvent",
            "id":"production-publishEvent"
        },
        {
            "headers":{
                "header1":"value1"
            },
            "subEntityTruncationSize":null,
            "urls":[
                "https://localhost:8080/submitOrder"
            ],
            "includeChangesOnly":false,
            "urlApplicationSuppressionList":[
                {
                    "url":"https://example.com",
                    "applications":[
                        "applicationId1"
                    ]
                }
            ],
            "displayName":"atg.service.webhook.Resources->webHookDisplayName_submitOrder",
            "serverType":"production",
            "name":"submitOrder",
            "id":"production-submitOrder",
            "basicAuthentication":{
                "admin":"admin123"
            }
        }
    ]
}

Nested Schema : basicAuthentication

Type: object

Map of username and password

Show Source

password(optional): string

The password.
username(optional): string

The user name.

{
    "description":"Map of username and password",
    "type":"object",
    "properties":{
        "password":{
            "description":"The password.",
            "type":"string"
        },
        "username":{
            "description":"The user name.",
            "type":"string"
        }
    }
}

Nested Schema : headers

Type: object

Map of header names and header values

Show Source

headerName(optional): string

The header name.
headerValue(optional): string

The header value.

{
    "description":"Map of header names and header values",
    "type":"object",
    "properties":{
        "headerName":{
            "description":"The header name.",
            "type":"string"
        },
        "headerValue":{
            "description":"The header value.",
            "type":"string"
        }
    }
}

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

Array of: object items

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "url":{
                "description":"The URL to be suppressed.",
                "type":"string"
            },
            "applications":{
                "description":"Array of strings representing application Ids, events triggered by which should suppress the URL.",
                "type":"array",
                "items":{
                    "description":"Id of the registered application. Refer to /ccadmin/v1/applicationIds for more details.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : urls

Type: array

An array of strings of the target URLs for the WebHook.

Show Source

Array of: string

{
    "description":"An array of strings of the target URLs for the WebHook.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

applications(optional): array applications

Array of strings representing application Ids, events triggered by which should suppress the URL.
url(optional): string

The URL to be suppressed.

{
    "type":"object",
    "properties":{
        "url":{
            "description":"The URL to be suppressed.",
            "type":"string"
        },
        "applications":{
            "description":"Array of strings representing application Ids, events triggered by which should suppress the URL.",
            "type":"array",
            "items":{
                "description":"Id of the registered application. Refer to /ccadmin/v1/applicationIds for more details.",
                "type":"string"
            }
        }
    }
}

Nested Schema : applications

Type: array

Array of strings representing application Ids, events triggered by which should suppress the URL.

Show Source

Array of: string

Id of the registered application. Refer to /ccadmin/v1/applicationIds for more details.

{
    "description":"Array of strings representing application Ids, events triggered by which should suppress the URL.",
    "type":"array",
    "items":{
        "description":"Id of the registered application. Refer to /ccadmin/v1/applicationIds for more details.",
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : updateWebHooks_response

Type: object

Show Source

applyResendDelayToFirstAttempt(optional): boolean

Apply resend delay in first attempt
basicAuthentication(optional): object basicAuthentication

Map of username and password
displayName(optional): integer

The display name of the WebHook.
headers(optional): object headers

Map of header names and header values
id(optional): integer

WebHook identifier.
includeChangesOnly(optional): boolean

The webhook payload will include only the changes for list and map properties when this value is set as true
maxNumberOfResendAttempts(optional): integer

Max number of resend attempts
name(optional): integer

The simple name of the WebHook.
resendDelaySeconds(optional): integer

Resend delay in seconds
secretKey(optional): integer

The base64 encoded 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 "submitOrder"). The secret key will have a non-null value only if the authentication method was previously chosen as secret key.
serverType(optional): integer

The server type of the WebHook.
subEntityTruncationSize(optional): integer

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
urlApplicationSuppressionList(optional): array 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.
urls(optional): array urls

An array of strings of the target URLs for the WebHook.

{
    "properties":{
        "resendDelaySeconds":{
            "description":"Resend delay in seconds",
            "type":"integer"
        },
        "headers":{
            "description":"Map of header names and header values",
            "type":"object",
            "properties":{
                "headerName":{
                    "description":"The header name.",
                    "type":"string"
                },
                "headerValue":{
                    "description":"The header value.",
                    "type":"string"
                }
            }
        },
        "includeChangesOnly":{
            "description":"The webhook payload will include only the changes for list and map properties when this value is set as true",
            "type":"boolean"
        },
        "secretKey":{
            "description":"The base64 encoded 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 \"submitOrder\"). The secret key will have a non-null value only if the authentication method was previously chosen as secret key.",
            "type":"integer"
        },
        "urlApplicationSuppressionList":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "url":{
                        "description":"The URL to be suppressed.",
                        "type":"string"
                    },
                    "applications":{
                        "description":"Array of strings representing application Ids, events triggered by which should suppress the URL.",
                        "type":"array",
                        "items":{
                            "description":"Id of the registered application. Refer to /ccadmin/v1/applicationIds for more details.",
                            "type":"string"
                        }
                    }
                }
            }
        },
        "displayName":{
            "description":"The display name of the WebHook.",
            "type":"integer"
        },
        "basicAuthentication":{
            "description":"Map of username and password",
            "type":"object",
            "properties":{
                "password":{
                    "description":"The password.",
                    "type":"string"
                },
                "username":{
                    "description":"The user name.",
                    "type":"string"
                }
            }
        },
        "maxNumberOfResendAttempts":{
            "description":"Max number of resend attempts",
            "type":"integer"
        },
        "subEntityTruncationSize":{
            "description":"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",
            "type":"integer"
        },
        "urls":{
            "description":"An array of strings of the target URLs for the WebHook.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "serverType":{
            "description":"The server type of the WebHook.",
            "type":"integer"
        },
        "name":{
            "description":"The simple name of the WebHook.",
            "type":"integer"
        },
        "id":{
            "description":"WebHook identifier.",
            "type":"integer"
        },
        "applyResendDelayToFirstAttempt":{
            "description":"Apply resend delay in first attempt",
            "type":"boolean"
        }
    }
}

Nested Schema : basicAuthentication

Type: object

Map of username and password

Show Source

password(optional): string

The password.
username(optional): string

The user name.

{
    "description":"Map of username and password",
    "type":"object",
    "properties":{
        "password":{
            "description":"The password.",
            "type":"string"
        },
        "username":{
            "description":"The user name.",
            "type":"string"
        }
    }
}

Nested Schema : headers

Type: object

Map of header names and header values

Show Source

headerName(optional): string

The header name.
headerValue(optional): string

The header value.

{
    "description":"Map of header names and header values",
    "type":"object",
    "properties":{
        "headerName":{
            "description":"The header name.",
            "type":"string"
        },
        "headerValue":{
            "description":"The header value.",
            "type":"string"
        }
    }
}

Nested Schema : urlApplicationSuppressionList

Type: array

Show Source

Array of: object items

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "url":{
                "description":"The URL to be suppressed.",
                "type":"string"
            },
            "applications":{
                "description":"Array of strings representing application Ids, events triggered by which should suppress the URL.",
                "type":"array",
                "items":{
                    "description":"Id of the registered application. Refer to /ccadmin/v1/applicationIds for more details.",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : urls

Type: array

An array of strings of the target URLs for the WebHook.

Show Source

Array of: string

{
    "description":"An array of strings of the target URLs for the WebHook.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

applications(optional): array applications

Array of strings representing application Ids, events triggered by which should suppress the URL.
url(optional): string

The URL to be suppressed.

{
    "type":"object",
    "properties":{
        "url":{
            "description":"The URL to be suppressed.",
            "type":"string"
        },
        "applications":{
            "description":"Array of strings representing application Ids, events triggered by which should suppress the URL.",
            "type":"array",
            "items":{
                "description":"Id of the registered application. Refer to /ccadmin/v1/applicationIds for more details.",
                "type":"string"
            }
        }
    }
}

Nested Schema : applications

Type: array

Array of strings representing application Ids, events triggered by which should suppress the URL.

Show Source

Array of: string

Id of the registered application. Refer to /ccadmin/v1/applicationIds for more details.

{
    "description":"Array of strings representing application Ids, events triggered by which should suppress the URL.",
    "type":"array",
    "items":{
        "description":"Id of the registered application. Refer to /ccadmin/v1/applicationIds for more details.",
        "type":"string"
    }
}

Example Response (application/json)

[
    {
        "resendDelaySeconds":null,
        "headers":null,
        "includeChangesOnly":false,
        "secretKey":"hVk7Bm+vgoxCY8r6N+1br2nCa8+OslDHJQMsgiqcJbuxeGP9vxjdShO5+3r6klxFTdexEIByNt9gxgvmRW5JNw==",
        "urlApplicationSuppressionList":[
            {
                "url":"https://example.com",
                "applications":[
                    "applicationId1"
                ]
            }
        ],
        "displayName":"atg.service.webhook.Resources->webHookDisplayName_publishEvent",
        "basicAuthentication":null,
        "maxNumberOfResendAttempts":null,
        "subEntityTruncationSize":null,
        "urls":null,
        "serverType":"production",
        "name":"publishEvent",
        "id":"production-publishEvent",
        "applyResendDelayToFirstAttempt":null
    },
    {
        "resendDelaySeconds":null,
        "headers":{
            "header1":"value1"
        },
        "includeChangesOnly":false,
        "secretKey":null,
        "urlApplicationSuppressionList":[
            {
                "url":"https://example.com",
                "applications":[
                    "applicationId1"
                ]
            }
        ],
        "displayName":"atg.service.webhook.Resources->webHookDisplayName_submitOrder",
        "basicAuthentication":{
            "admin":"admin123"
        },
        "maxNumberOfResendAttempts":null,
        "subEntityTruncationSize":null,
        "urls":[
            "https://localhost:8080/submitOrder"
        ],
        "serverType":"production",
        "name":"submitOrder",
        "id":"production-submitOrder",
        "applyResendDelayToFirstAttempt":null
    }
]

Default Response

The error response

Root Schema : errorModel

Type: object

Show Source

devMessage(optional): string

An optional non-localized message containing technical information for developers
errorCode(optional): string

The numerical code identifying the error
errors(optional): array errors

An optional list of errors if multiple errors were encountered
message(optional): string

The localized message describing the error
moreInfo(optional): string

An optional non-localized message with more information
o:errorPath(optional): string

An optional machine readable description of where the error occurred
status(optional): string

The HTTP status code
type(optional): string

The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

devMessage(optional): string

An optional non-localized message containing technical information for developers
errorCode(optional): string

The numerical code identifying the error
message(optional): string

The localized message describing the error
moreInfo(optional): string

An optional non-localized message with more information
o:errorPath(optional): string

An optional machine readable description of where the error occurred
status(optional): string

The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}