getFunctionWebHooks

get

/ccadmin/v1/functionWebhooks

Get Function Web Hooks. Gets an array of function WebHooks. Response can be narrowed by a "serverType parameter". Each element of the returned array follows the format of that returned by getWebHook.

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getFunctionWebHooks_response
Type: object
Show Source
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":{
            "header1":"value1"
        },
        "subEntityTruncationSize":null,
        "synchronousRetries":0,
        "secretKey":null,
        "urlApplicationSuppressionList":[
            {
                "url":"https://example.com",
                "applications":[
                    "applicationId1"
                ]
            }
        ],
        "supportsSynchronousRetry":false,
        "displayName":"atg.service.webhook.Resources->webHookDisplayName_calculateShipping",
        "serverType":"production",
        "name":"calculateShipping",
        "id":"production-calculateShipping",
        "basicAuthentication":{
            "admin":"admin"
        },
        "url":null
    },
    {
        "headers":null,
        "subEntityTruncationSize":null,
        "synchronousRetries":0,
        "secretKey":null,
        "urlApplicationSuppressionList":[
            {
                "url":"https://example.com",
                "applications":[
                    "applicationId1"
                ]
            }
        ],
        "supportsSynchronousRetry":false,
        "displayName":"Calculate Shipping - Publishing",
        "serverType":"publishing",
        "name":"calculateShipping",
        "id":"publishing-calculateShipping",
        "basicAuthentication":null,
        "url":null
    }
]

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