Jump to

• Request
• Response

webHookOperation

post

/ccadmin/v1/webhooks/{id}

Web Hook Operation. Perform an operation on a 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.

Body ()

Root Schema : webHookOperation_request

Type: object

Show Source

• op: string
  The operation to perform. Valid values are: resetSecretKey

{
    "properties":{
        "op":{
            "description":"The operation to perform. Valid values are: resetSecretKey",
            "type":"string"
        }
    },
    "required":[
        "op"
    ],
    "example":{
        "op":"resetSecretKey"
    }
}

Example:

{
    "op":"resetSecretKey"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : webHookOperation_response

Type: object

Show Source

• 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 "submitOrder"). The secret key will have a non-null value only if the authentication method was previously chosen as secret key.

{
    "properties":{
        "secretKey":{
            "description":"The base64 encoded secret key of the WebHook. 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":"string"
        },
        "id":{
            "description":"WebHook identifier.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "secretKey":"jCFq0IhpO7Qk7Fr5H3tHpMckhroKRhiTcMR15PKywH9B8QoA4lRgDaoSg46mAh+W4z3G2c1dHeVEOgMaMIBjUA==",
    "id":"production-submitOrder"
}

Default Response

The error response

Body ()

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"
        }
    }
}

Back to Top