functionWebHookOperation
post
/ccadmin/v1/functionWebhooks/{id}
Function Web Hook Operation. Perform an operation on a function WebHook, like reset the secret key of a specific WebHook with the help of provided ID.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID corresponding to the WebHook whose secret key is to be reset.
Root Schema : functionWebHookOperation_request
Type:
Show Source
object
-
op:
string
The operation to perform. Valid values are: resetSecretKey
Example:
{
"op":"resetSecretKey"
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : functionWebHookOperation_response
Type:
Show Source
object
-
id(optional):
string
WebHook identifier.
-
secretKey(optional):
string
The base64 encoded secret key of the WebHook. 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.
Example Response (application/json)
{
"secretKey":"jCFq0IhpO7Qk7Fr5H3tHpMckhroKRhiTcMR15PKywH9B8QoA4lRgDaoSg46mAh+W4z3G2c1dHeVEOgMaMIBjUA==",
"id":"production-calculateShipping"
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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