REST API for Oracle Commerce Cloud December 2017

updateWebHook

put

/ccadmin/v1/webhooks/{id}

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

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

ID corresponding to the WebHook which is to be updated.

Body Parameter

Root Schema : updateWebHook_request

Example


{
    "headers":{
        "header1":"value1"
    },
    "urls":[
        "https://localhost:8080/submitOrder"
    ],
    "displayName":"atg.service.webhook.Resources->webHookDisplayName_submitOrder",
    "serverType":"production",
    "name":"submitOrder",
    "id":"production-submitOrder",
    "basicAuthentication":{
        "admin":"admin123"
    }
}

Properties

applyResendDelayToFirstAttempt: Type: boolean

Apply resend delay in first attempt
basicAuthentication: Type: object basicAuthentication

Additional Properties Allowed:

Map of username and password
displayName: Type: integer

The display name of the WebHook.
headers: Type: object headers

Additional Properties Allowed:

Map of header names and header values
id: Type: integer

WebHook identifier.
maxNumberOfResendAttempts: Type: integer

Max number of resend attempts
name: Type: integer

The simple name of the WebHook.
resendDelaySeconds: Type: integer

Resend delay in seconds
secretKey: Type: 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: Type: integer

The server type of the WebHook.
urls: Type: array urls

Additional Properties Allowed:

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

Nested Schema : basicAuthentication

Type: object

Map of username and password

Properties

password: Type: string

The password.
username: Type: string

The user name.

Nested Schema : headers

Type: object

Map of header names and header values

Properties

headerName: Type: string

The header name.
headerValue: Type: string

The header value.

Nested Schema : urls

Type: array

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

Items

Type: string

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateWebHook_response

Properties

applyResendDelayToFirstAttempt: Type: boolean

Apply resend delay in first attempt
basicAuthentication: Type: object basicAuthentication

Additional Properties Allowed:

Map of username and password
displayName: Type: integer

The display name of the WebHook.
headers: Type: object headers

Additional Properties Allowed:

Map of header names and header values
id: Type: integer

WebHook identifier.
maxNumberOfResendAttempts: Type: integer

Max number of resend attempts
name: Type: integer

The simple name of the WebHook.
resendDelaySeconds: Type: integer

Resend delay in seconds
secretKey: Type: 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: Type: integer

The server type of the WebHook.
urls: Type: array urls

Additional Properties Allowed:

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

Nested Schema : basicAuthentication

Type: object

Map of username and password

Properties

password: Type: string

The password.
username: Type: string

The user name.

Nested Schema : headers

Type: object

Map of header names and header values

Properties

headerName: Type: string

The header name.
headerValue: Type: string

The header value.

Nested Schema : urls

Type: array

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

Items

Type: string

Example application/json


{
    "headers":{
        "header1":"value1"
    },
    "urls":[
        "https://localhost:8080/submitOrder"
    ],
    "displayName":"atg.service.webhook.Resources->webHookDisplayName_submitOrder",
    "serverType":"production",
    "name":"submitOrder",
    "id":"production-submitOrder",
    "basicAuthentication":{
        "admin":"admin123"
    }
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

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

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

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

The localized message describing the error
moreInfo: Type: string

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

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

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

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

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

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

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

The HTTP status code

Examples

Sample Request:

{
  "headers": {"header1": "value1"},
  "urls": ["https://localhost:8080/submitOrder"],
  "displayName": "atg.service.webhook.Resources->webHookDisplayName_submitOrder",
  "serverType": "production",
  "name": "submitOrder",
  "id": "production-submitOrder",
  "basicAuthentication": {"admin": "admin123"}
}

Sample Response Payload returned by endpoint:

{
  "headers": {"header1": "value1"},
  "urls": ["https://localhost:8080/submitOrder"],
  "displayName": "atg.service.webhook.Resources->webHookDisplayName_submitOrder",
  "serverType": "production",
  "name": "submitOrder",
  "id": "production-submitOrder",
  "basicAuthentication": {"admin": "admin123"}
}