Webhook Configuration Service API

Metadata

metadataGet

Retrieves the EDMX document for the webhook service.

Retrieves the metadata for the webhook services integration object. The metadata consists of an Entity Data Model XML (EDMX) schema that describes the entity types and their properties.


/$metadata

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/xml"\
"https://localhost:9002/odata2webservices/WebhookService/$metadata"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MetadataApi;

import java.io.File;
import java.util.*;

public class MetadataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        MetadataApi apiInstance = new MetadataApi();
        try {
            apiInstance.metadataGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling MetadataApi#metadataGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MetadataApi;

public class MetadataApiExample {

    public static void main(String[] args) {
        MetadataApi apiInstance = new MetadataApi();
        try {
            apiInstance.metadataGet();
        } catch (ApiException e) {
            System.err.println("Exception when calling MetadataApi#metadataGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

MetadataApi *apiInstance = [[MetadataApi alloc] init];

// Retrieves the EDMX document for the webhook service.
[apiInstance metadataGetWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WebhookConfigurationServiceApi = require('webhook_configuration_service_api');
var defaultClient = WebhookConfigurationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new WebhookConfigurationServiceApi.MetadataApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.metadataGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class metadataGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new MetadataApi();

            try
            {
                // Retrieves the EDMX document for the webhook service.
                apiInstance.metadataGet();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetadataApi.metadataGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiMetadataApi();

try {
    $api_instance->metadataGet();
} catch (Exception $e) {
    echo 'Exception when calling MetadataApi->metadataGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MetadataApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::MetadataApi->new();

eval { 
    $api_instance->metadataGet();
};
if ($@) {
    warn "Exception when calling MetadataApi->metadataGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.MetadataApi()

try: 
    # Retrieves the EDMX document for the webhook service.
    api_instance.metadata_get()
except ApiException as e:
    print("Exception when calling MetadataApi->metadataGet: %s\n" % e)

Parameters

Responses

Status: 200 - A valid EDMX schema.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses


WebhookConfigurations

webhookConfigurationsGet

Retrieves the webhook configurations.

Retrieves the details of the webhook configurations.


/WebhookConfigurations

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://localhost:9002/odata2webservices/WebhookService/WebhookConfigurations?$top=&$skip=&$filter=&$inlinecount=&$expand="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebhookConfigurationsApi;

import java.io.File;
import java.util.*;

public class WebhookConfigurationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        WebhookConfigurationsApi apiInstance = new WebhookConfigurationsApi();
        Integer $top = 56; // Integer | The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
        Integer $skip = 56; // Integer | The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
        String $filter = $filter_example; // String | A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html)
        String $inlinecount = ; // String | Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html)
        String $expand = $expand_example; // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)
        try {
            Wrapper result = apiInstance.webhookConfigurationsGet($top, $skip, $filter, $inlinecount, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookConfigurationsApi#webhookConfigurationsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WebhookConfigurationsApi;

public class WebhookConfigurationsApiExample {

    public static void main(String[] args) {
        WebhookConfigurationsApi apiInstance = new WebhookConfigurationsApi();
        Integer $top = 56; // Integer | The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
        Integer $skip = 56; // Integer | The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
        String $filter = $filter_example; // String | A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html)
        String $inlinecount = ; // String | Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html)
        String $expand = $expand_example; // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)
        try {
            Wrapper result = apiInstance.webhookConfigurationsGet($top, $skip, $filter, $inlinecount, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookConfigurationsApi#webhookConfigurationsGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
Integer *$top = 56; // The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html) (optional)
Integer *$skip = 56; // The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html) (optional)
String *$filter = $filter_example; // A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html) (optional)
String *$inlinecount = ; // Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html) (optional)
String *$expand = $expand_example; // Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html) (optional)

WebhookConfigurationsApi *apiInstance = [[WebhookConfigurationsApi alloc] init];

// Retrieves the webhook configurations.
[apiInstance webhookConfigurationsGetWith:$top
    $skip:$skip
    $filter:$filter
    $inlinecount:$inlinecount
    $expand:$expand
              completionHandler: ^(Wrapper output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WebhookConfigurationServiceApi = require('webhook_configuration_service_api');
var defaultClient = WebhookConfigurationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new WebhookConfigurationServiceApi.WebhookConfigurationsApi()
var opts = { 
  '$top': 56, // {{Integer}} The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
  '$skip': 56, // {{Integer}} The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
  '$filter': $filter_example, // {{String}} A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html)
  '$inlinecount': , // {{String}} Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html)
  '$expand': $expand_example // {{String}} Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.webhookConfigurationsGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class webhookConfigurationsGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new WebhookConfigurationsApi();
            var $top = 56;  // Integer | The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html) (optional) 
            var $skip = 56;  // Integer | The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html) (optional) 
            var $filter = $filter_example;  // String | A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html) (optional) 
            var $inlinecount = new String(); // String | Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html) (optional) 
            var $expand = $expand_example;  // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html) (optional) 

            try
            {
                // Retrieves the webhook configurations.
                Wrapper result = apiInstance.webhookConfigurationsGet($top, $skip, $filter, $inlinecount, $expand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhookConfigurationsApi.webhookConfigurationsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiWebhookConfigurationsApi();
$$top = 56; // Integer | The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
$$skip = 56; // Integer | The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
$$filter = $filter_example; // String | A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html)
$$inlinecount = ; // String | Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html)
$$expand = $expand_example; // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)

try {
    $result = $api_instance->webhookConfigurationsGet($$top, $$skip, $$filter, $$inlinecount, $$expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhookConfigurationsApi->webhookConfigurationsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WebhookConfigurationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::WebhookConfigurationsApi->new();
my $$top = 56; # Integer | The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
my $$skip = 56; # Integer | The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
my $$filter = $filter_example; # String | A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html)
my $$inlinecount = ; # String | Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html)
my $$expand = $expand_example; # String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)

eval { 
    my $result = $api_instance->webhookConfigurationsGet($top => $$top, $skip => $$skip, $filter => $$filter, $inlinecount => $$inlinecount, $expand => $$expand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhookConfigurationsApi->webhookConfigurationsGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.WebhookConfigurationsApi()
$top = 56 # Integer | The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html) (optional)
$skip = 56 # Integer | The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html) (optional)
$filter = $filter_example # String | A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html) (optional)
$inlinecount =  # String | Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html) (optional)
$expand = $expand_example # String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html) (optional)

try: 
    # Retrieves the webhook configurations.
    api_response = api_instance.webhook_configurations_get($top=$top, $skip=$skip, $filter=$filter, $inlinecount=$inlinecount, $expand=$expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhookConfigurationsApi->webhookConfigurationsGet: %s\n" % e)

Parameters

Query parameters
Name Description
$top
Integer
The maximum number of items to return. If it's greater than or equal to the number of matching items existing in the platform, then all items will be returned. If it's less than the number of matching items in the platform, a subset containing top number of items will be returned. See [$top](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
$skip
Integer
The number of matching items to skip over before returning the result set. If skip is larger than the number of matching items then no items will be returned. See [$skip](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/cf34b9bbd7d94e0c9eb37e5147d20da1.html)
$filter
String
A predicate expression for selecting a subset of the items identified by the resource path. See [$filter](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/eaaf8deda5b34842b6857ed1e5f0dab6.html)
$inlinecount
String
Specifies if the total number of items should be included in the response. See [$inlinecount](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/04feab0a91ee4763939eeafc95d8d386.html)
$expand
String
Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)

Responses

Status: 200 - A collection of 0 or more WebhookConfigurations.

Status: 400 - Error responses that may occur due to an exception related to the filter query parameter.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

Status: 404 - Not Found exception responses for GET operations.


webhookConfigurationsIntegrationKeyDelete

Deletes a webhook configuration.

Deletes a webhook configuration with the corresponding integration key.


/WebhookConfigurations(%27{integrationKey}%27)

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://localhost:9002/odata2webservices/WebhookService/WebhookConfigurations(%27{integrationKey}%27)"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebhookConfigurationsApi;

import java.io.File;
import java.util.*;

public class WebhookConfigurationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        WebhookConfigurationsApi apiInstance = new WebhookConfigurationsApi();
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String integrationMessageId = integrationMessageId_example; // String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.
        try {
            apiInstance.webhookConfigurationsIntegrationKeyDelete(integrationKey, integrationMessageId);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookConfigurationsApi#webhookConfigurationsIntegrationKeyDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WebhookConfigurationsApi;

public class WebhookConfigurationsApiExample {

    public static void main(String[] args) {
        WebhookConfigurationsApi apiInstance = new WebhookConfigurationsApi();
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String integrationMessageId = integrationMessageId_example; // String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.
        try {
            apiInstance.webhookConfigurationsIntegrationKeyDelete(integrationKey, integrationMessageId);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookConfigurationsApi#webhookConfigurationsIntegrationKeyDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *integrationKey = integrationKey_example; // key: integrationKey
String *integrationMessageId = integrationMessageId_example; // The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request. (optional)

WebhookConfigurationsApi *apiInstance = [[WebhookConfigurationsApi alloc] init];

// Deletes a webhook configuration.
[apiInstance webhookConfigurationsIntegrationKeyDeleteWith:integrationKey
    integrationMessageId:integrationMessageId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WebhookConfigurationServiceApi = require('webhook_configuration_service_api');
var defaultClient = WebhookConfigurationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new WebhookConfigurationServiceApi.WebhookConfigurationsApi()
var integrationKey = integrationKey_example; // {{String}} key: integrationKey
var opts = { 
  'integrationMessageId': integrationMessageId_example // {{String}} The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.webhookConfigurationsIntegrationKeyDelete(integrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class webhookConfigurationsIntegrationKeyDeleteExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new WebhookConfigurationsApi();
            var integrationKey = integrationKey_example;  // String | key: integrationKey
            var integrationMessageId = integrationMessageId_example;  // String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request. (optional) 

            try
            {
                // Deletes a webhook configuration.
                apiInstance.webhookConfigurationsIntegrationKeyDelete(integrationKey, integrationMessageId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhookConfigurationsApi.webhookConfigurationsIntegrationKeyDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiWebhookConfigurationsApi();
$integrationKey = integrationKey_example; // String | key: integrationKey
$integrationMessageId = integrationMessageId_example; // String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.

try {
    $api_instance->webhookConfigurationsIntegrationKeyDelete($integrationKey, $integrationMessageId);
} catch (Exception $e) {
    echo 'Exception when calling WebhookConfigurationsApi->webhookConfigurationsIntegrationKeyDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WebhookConfigurationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::WebhookConfigurationsApi->new();
my $integrationKey = integrationKey_example; # String | key: integrationKey
my $integrationMessageId = integrationMessageId_example; # String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.

eval { 
    $api_instance->webhookConfigurationsIntegrationKeyDelete(integrationKey => $integrationKey, integrationMessageId => $integrationMessageId);
};
if ($@) {
    warn "Exception when calling WebhookConfigurationsApi->webhookConfigurationsIntegrationKeyDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.WebhookConfigurationsApi()
integrationKey = integrationKey_example # String | key: integrationKey
integrationMessageId = integrationMessageId_example # String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request. (optional)

try: 
    # Deletes a webhook configuration.
    api_instance.webhook_configurations_integration_key_delete(integrationKey, integrationMessageId=integrationMessageId)
except ApiException as e:
    print("Exception when calling WebhookConfigurationsApi->webhookConfigurationsIntegrationKeyDelete: %s\n" % e)

Parameters

Path parameters
Name Description
integrationKey*
String
key: integrationKey
Required
Header parameters
Name Description
integrationMessageId
String
The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.

Responses

Status: 200 - Indicates that the Webhook Configuration was successfully deleted.

Status: 400 - Error responses that may occur when a DELETE request is made in an attempt to delete an item.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

Status: 404 - Not Found exception responses for PATCH and DELETE operations.


webhookConfigurationsIntegrationKeyGet

Retrieves a webhook configuration.

Retrieves a webhook configuration by its integration key.


/WebhookConfigurations(%27{integrationKey}%27)

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
"https://localhost:9002/odata2webservices/WebhookService/WebhookConfigurations(%27{integrationKey}%27)?$expand="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebhookConfigurationsApi;

import java.io.File;
import java.util.*;

public class WebhookConfigurationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        WebhookConfigurationsApi apiInstance = new WebhookConfigurationsApi();
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String $expand = $expand_example; // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)
        try {
            Wrapper_1 result = apiInstance.webhookConfigurationsIntegrationKeyGet(integrationKey, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookConfigurationsApi#webhookConfigurationsIntegrationKeyGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WebhookConfigurationsApi;

public class WebhookConfigurationsApiExample {

    public static void main(String[] args) {
        WebhookConfigurationsApi apiInstance = new WebhookConfigurationsApi();
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String $expand = $expand_example; // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)
        try {
            Wrapper_1 result = apiInstance.webhookConfigurationsIntegrationKeyGet(integrationKey, $expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookConfigurationsApi#webhookConfigurationsIntegrationKeyGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
String *integrationKey = integrationKey_example; // key: integrationKey
String *$expand = $expand_example; // Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html) (optional)

WebhookConfigurationsApi *apiInstance = [[WebhookConfigurationsApi alloc] init];

// Retrieves a webhook configuration.
[apiInstance webhookConfigurationsIntegrationKeyGetWith:integrationKey
    $expand:$expand
              completionHandler: ^(Wrapper_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WebhookConfigurationServiceApi = require('webhook_configuration_service_api');
var defaultClient = WebhookConfigurationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new WebhookConfigurationServiceApi.WebhookConfigurationsApi()
var integrationKey = integrationKey_example; // {{String}} key: integrationKey
var opts = { 
  '$expand': $expand_example // {{String}} Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.webhookConfigurationsIntegrationKeyGet(integrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class webhookConfigurationsIntegrationKeyGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new WebhookConfigurationsApi();
            var integrationKey = integrationKey_example;  // String | key: integrationKey
            var $expand = $expand_example;  // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html) (optional) 

            try
            {
                // Retrieves a webhook configuration.
                Wrapper_1 result = apiInstance.webhookConfigurationsIntegrationKeyGet(integrationKey, $expand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhookConfigurationsApi.webhookConfigurationsIntegrationKeyGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiWebhookConfigurationsApi();
$integrationKey = integrationKey_example; // String | key: integrationKey
$$expand = $expand_example; // String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)

try {
    $result = $api_instance->webhookConfigurationsIntegrationKeyGet($integrationKey, $$expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhookConfigurationsApi->webhookConfigurationsIntegrationKeyGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WebhookConfigurationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::WebhookConfigurationsApi->new();
my $integrationKey = integrationKey_example; # String | key: integrationKey
my $$expand = $expand_example; # String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)

eval { 
    my $result = $api_instance->webhookConfigurationsIntegrationKeyGet(integrationKey => $integrationKey, $expand => $$expand);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhookConfigurationsApi->webhookConfigurationsIntegrationKeyGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.WebhookConfigurationsApi()
integrationKey = integrationKey_example # String | key: integrationKey
$expand = $expand_example # String | Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html) (optional)

try: 
    # Retrieves a webhook configuration.
    api_response = api_instance.webhook_configurations_integration_key_get(integrationKey, $expand=$expand)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhookConfigurationsApi->webhookConfigurationsIntegrationKeyGet: %s\n" % e)

Parameters

Path parameters
Name Description
integrationKey*
String
key: integrationKey
Required
Query parameters
Name Description
$expand
String
Specifies navigation properties for associated entries that will be inlined in the response body. By default, these navigation properties are represented as deferred links pointing to the item resource. See [$expand](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/d990bd1fbc98479d97078aa3890f5bb3.html)

Responses

Status: 200 - Success response with the retrieved WebhookConfiguration.

Status: 400 - Error responses that may occur when a DELETE request is made in an attempt to delete an item.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

Status: 404 - Not Found exception responses for GET operations.


webhookConfigurationsIntegrationKeyPatch

Updates a webhook configuration.

Updates a webhook configuration with the corresponding integration key. For more information about the PATCH behavior, see [Webhook Configuration Examples](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/7c5aff89a5fd4861a467a1a0f1a49408.html).


/WebhookConfigurations(%27{integrationKey}%27)

Usage and SDK Samples

curl -X PATCH\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://localhost:9002/odata2webservices/WebhookService/WebhookConfigurations(%27{integrationKey}%27)"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebhookConfigurationsApi;

import java.io.File;
import java.util.*;

public class WebhookConfigurationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        WebhookConfigurationsApi apiInstance = new WebhookConfigurationsApi();
        WebhookConfiguration body = ; // WebhookConfiguration | 
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String prePersistHook = prePersistHook_example; // String | The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
        String postPersistHook = postPersistHook_example; // String | The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
        String integrationMessageId = integrationMessageId_example; // String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.
        try {
            Wrapper_1 result = apiInstance.webhookConfigurationsIntegrationKeyPatch(body, integrationKey, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookConfigurationsApi#webhookConfigurationsIntegrationKeyPatch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WebhookConfigurationsApi;

public class WebhookConfigurationsApiExample {

    public static void main(String[] args) {
        WebhookConfigurationsApi apiInstance = new WebhookConfigurationsApi();
        WebhookConfiguration body = ; // WebhookConfiguration | 
        String integrationKey = integrationKey_example; // String | key: integrationKey
        String prePersistHook = prePersistHook_example; // String | The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
        String postPersistHook = postPersistHook_example; // String | The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
        String integrationMessageId = integrationMessageId_example; // String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.
        try {
            Wrapper_1 result = apiInstance.webhookConfigurationsIntegrationKeyPatch(body, integrationKey, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookConfigurationsApi#webhookConfigurationsIntegrationKeyPatch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
WebhookConfiguration *body = ; // 
String *integrationKey = integrationKey_example; // key: integrationKey
String *prePersistHook = prePersistHook_example; // The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html) (optional)
String *postPersistHook = postPersistHook_example; // The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html) (optional)
String *integrationMessageId = integrationMessageId_example; // The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request. (optional)

WebhookConfigurationsApi *apiInstance = [[WebhookConfigurationsApi alloc] init];

// Updates a webhook configuration.
[apiInstance webhookConfigurationsIntegrationKeyPatchWith:body
    integrationKey:integrationKey
    prePersistHook:prePersistHook
    postPersistHook:postPersistHook
    integrationMessageId:integrationMessageId
              completionHandler: ^(Wrapper_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WebhookConfigurationServiceApi = require('webhook_configuration_service_api');
var defaultClient = WebhookConfigurationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new WebhookConfigurationServiceApi.WebhookConfigurationsApi()
var body = ; // {{WebhookConfiguration}} 
var integrationKey = integrationKey_example; // {{String}} key: integrationKey
var opts = { 
  'prePersistHook': prePersistHook_example // {{String}} The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
  'postPersistHook': postPersistHook_example // {{String}} The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
  'integrationMessageId': integrationMessageId_example // {{String}} The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.webhookConfigurationsIntegrationKeyPatch(bodyintegrationKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class webhookConfigurationsIntegrationKeyPatchExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new WebhookConfigurationsApi();
            var body = new WebhookConfiguration(); // WebhookConfiguration | 
            var integrationKey = integrationKey_example;  // String | key: integrationKey
            var prePersistHook = prePersistHook_example;  // String | The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html) (optional) 
            var postPersistHook = postPersistHook_example;  // String | The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html) (optional) 
            var integrationMessageId = integrationMessageId_example;  // String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request. (optional) 

            try
            {
                // Updates a webhook configuration.
                Wrapper_1 result = apiInstance.webhookConfigurationsIntegrationKeyPatch(body, integrationKey, prePersistHook, postPersistHook, integrationMessageId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhookConfigurationsApi.webhookConfigurationsIntegrationKeyPatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiWebhookConfigurationsApi();
$body = ; // WebhookConfiguration | 
$integrationKey = integrationKey_example; // String | key: integrationKey
$prePersistHook = prePersistHook_example; // String | The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
$postPersistHook = postPersistHook_example; // String | The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
$integrationMessageId = integrationMessageId_example; // String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.

try {
    $result = $api_instance->webhookConfigurationsIntegrationKeyPatch($body, $integrationKey, $prePersistHook, $postPersistHook, $integrationMessageId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhookConfigurationsApi->webhookConfigurationsIntegrationKeyPatch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WebhookConfigurationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::WebhookConfigurationsApi->new();
my $body = WWW::SwaggerClient::Object::WebhookConfiguration->new(); # WebhookConfiguration | 
my $integrationKey = integrationKey_example; # String | key: integrationKey
my $prePersistHook = prePersistHook_example; # String | The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
my $postPersistHook = postPersistHook_example; # String | The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
my $integrationMessageId = integrationMessageId_example; # String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.

eval { 
    my $result = $api_instance->webhookConfigurationsIntegrationKeyPatch(body => $body, integrationKey => $integrationKey, prePersistHook => $prePersistHook, postPersistHook => $postPersistHook, integrationMessageId => $integrationMessageId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhookConfigurationsApi->webhookConfigurationsIntegrationKeyPatch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.WebhookConfigurationsApi()
body =  # WebhookConfiguration | 
integrationKey = integrationKey_example # String | key: integrationKey
prePersistHook = prePersistHook_example # String | The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html) (optional)
postPersistHook = postPersistHook_example # String | The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html) (optional)
integrationMessageId = integrationMessageId_example # String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request. (optional)

try: 
    # Updates a webhook configuration.
    api_response = api_instance.webhook_configurations_integration_key_patch(body, integrationKey, prePersistHook=prePersistHook, postPersistHook=postPersistHook, integrationMessageId=integrationMessageId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhookConfigurationsApi->webhookConfigurationsIntegrationKeyPatch: %s\n" % e)

Parameters

Path parameters
Name Description
integrationKey*
String
key: integrationKey
Required
Header parameters
Name Description
Pre-Persist-Hook
String
The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
Post-Persist-Hook
String
The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
integrationMessageId
String
The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.
Body parameters
Name Description
body *

Responses

Status: 200 - Indicates the Webhook Configuration has been successfully updated.

Status: 400 - Error responses that may occur when a PATCH request is made in an attempt to update an item.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

Status: 404 - Not Found exception responses for PATCH and DELETE operations.

Status: 415 - Provided Media-Type is not supported


webhookConfigurationsPost

Creates a webhook configuration.

Creates a webhook configuration or updates an existing one in the system. For more information about the POST behavior, see [Webhook Configuration Examples](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/7c5aff89a5fd4861a467a1a0f1a49408.html).


/WebhookConfigurations

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://localhost:9002/odata2webservices/WebhookService/WebhookConfigurations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebhookConfigurationsApi;

import java.io.File;
import java.util.*;

public class WebhookConfigurationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        WebhookConfigurationsApi apiInstance = new WebhookConfigurationsApi();
        WebhookConfigurations_body body = ; // WebhookConfigurations_body | 
        String prePersistHook = prePersistHook_example; // String | The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
        String postPersistHook = postPersistHook_example; // String | The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
        String integrationMessageId = integrationMessageId_example; // String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.
        try {
            Wrapper_1 result = apiInstance.webhookConfigurationsPost(body, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookConfigurationsApi#webhookConfigurationsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WebhookConfigurationsApi;

public class WebhookConfigurationsApiExample {

    public static void main(String[] args) {
        WebhookConfigurationsApi apiInstance = new WebhookConfigurationsApi();
        WebhookConfigurations_body body = ; // WebhookConfigurations_body | 
        String prePersistHook = prePersistHook_example; // String | The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
        String postPersistHook = postPersistHook_example; // String | The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
        String integrationMessageId = integrationMessageId_example; // String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.
        try {
            Wrapper_1 result = apiInstance.webhookConfigurationsPost(body, prePersistHook, postPersistHook, integrationMessageId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookConfigurationsApi#webhookConfigurationsPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];
WebhookConfigurations_body *body = ; // 
String *prePersistHook = prePersistHook_example; // The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html) (optional)
String *postPersistHook = postPersistHook_example; // The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html) (optional)
String *integrationMessageId = integrationMessageId_example; // The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request. (optional)

WebhookConfigurationsApi *apiInstance = [[WebhookConfigurationsApi alloc] init];

// Creates a webhook configuration.
[apiInstance webhookConfigurationsPostWith:body
    prePersistHook:prePersistHook
    postPersistHook:postPersistHook
    integrationMessageId:integrationMessageId
              completionHandler: ^(Wrapper_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WebhookConfigurationServiceApi = require('webhook_configuration_service_api');
var defaultClient = WebhookConfigurationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new WebhookConfigurationServiceApi.WebhookConfigurationsApi()
var body = ; // {{WebhookConfigurations_body}} 
var opts = { 
  'prePersistHook': prePersistHook_example // {{String}} The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
  'postPersistHook': postPersistHook_example // {{String}} The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
  'integrationMessageId': integrationMessageId_example // {{String}} The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.webhookConfigurationsPost(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class webhookConfigurationsPostExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new WebhookConfigurationsApi();
            var body = new WebhookConfigurations_body(); // WebhookConfigurations_body | 
            var prePersistHook = prePersistHook_example;  // String | The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html) (optional) 
            var postPersistHook = postPersistHook_example;  // String | The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html) (optional) 
            var integrationMessageId = integrationMessageId_example;  // String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request. (optional) 

            try
            {
                // Creates a webhook configuration.
                Wrapper_1 result = apiInstance.webhookConfigurationsPost(body, prePersistHook, postPersistHook, integrationMessageId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhookConfigurationsApi.webhookConfigurationsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiWebhookConfigurationsApi();
$body = ; // WebhookConfigurations_body | 
$prePersistHook = prePersistHook_example; // String | The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
$postPersistHook = postPersistHook_example; // String | The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
$integrationMessageId = integrationMessageId_example; // String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.

try {
    $result = $api_instance->webhookConfigurationsPost($body, $prePersistHook, $postPersistHook, $integrationMessageId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhookConfigurationsApi->webhookConfigurationsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WebhookConfigurationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::WebhookConfigurationsApi->new();
my $body = WWW::SwaggerClient::Object::WebhookConfigurations_body->new(); # WebhookConfigurations_body | 
my $prePersistHook = prePersistHook_example; # String | The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
my $postPersistHook = postPersistHook_example; # String | The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
my $integrationMessageId = integrationMessageId_example; # String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.

eval { 
    my $result = $api_instance->webhookConfigurationsPost(body => $body, prePersistHook => $prePersistHook, postPersistHook => $postPersistHook, integrationMessageId => $integrationMessageId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhookConfigurationsApi->webhookConfigurationsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.WebhookConfigurationsApi()
body =  # WebhookConfigurations_body | 
prePersistHook = prePersistHook_example # String | The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html) (optional)
postPersistHook = postPersistHook_example # String | The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html) (optional)
integrationMessageId = integrationMessageId_example # String | The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request. (optional)

try: 
    # Creates a webhook configuration.
    api_response = api_instance.webhook_configurations_post(body, prePersistHook=prePersistHook, postPersistHook=postPersistHook, integrationMessageId=integrationMessageId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhookConfigurationsApi->webhookConfigurationsPost: %s\n" % e)

Parameters

Header parameters
Name Description
Pre-Persist-Hook
String
The execute method for the PrePersistHook invokes right before the Webhook Configuration sent in the POST or PATCH request persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
Post-Persist-Hook
String
The execute method for the PostPersistHook invokes right after the item persists in the SAP Commerce platform. For more details see [Persistence Hooks](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/028a2af06880407cb4b1c0624693dadd.html)
integrationMessageId
String
The integrationMessageId header allows the user to trace any [InboundRequest](https://help.sap.com/docs/SAP_COMMERCE_CLOUD_PUBLIC_CLOUD/bad9b0b66bac476f8a4a5c4a08e4ab6b/485b479c3b294d88916edea277e409a4.html) back to the original POST, PATCH or DELETE request.
Body parameters
Name Description
body *

Responses

Status: 201 - Indicates the Webhook Configuration has been successfully created/updated.

Status: 400 - Error responses that may occur due to an error occurring during an attempt to create a new Item.

Status: 401 - Unauthorized exception responses

Status: 403 - Forbidden exception responses

Status: 415 - Provided Media-Type is not supported


webhookConfigurationscountGet

Retrieves the number of webhook configurations.

Retrieves the total number of webhook configurations.


/WebhookConfigurations/$count

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Basic [[basicHash]]"\
-H "Accept: text/plain"\
"https://localhost:9002/odata2webservices/WebhookService/WebhookConfigurations/$count"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebhookConfigurationsApi;

import java.io.File;
import java.util.*;

public class WebhookConfigurationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        WebhookConfigurationsApi apiInstance = new WebhookConfigurationsApi();
        try {
            'String' result = apiInstance.webhookConfigurationscountGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookConfigurationsApi#webhookConfigurationscountGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WebhookConfigurationsApi;

public class WebhookConfigurationsApiExample {

    public static void main(String[] args) {
        WebhookConfigurationsApi apiInstance = new WebhookConfigurationsApi();
        try {
            'String' result = apiInstance.webhookConfigurationscountGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookConfigurationsApi#webhookConfigurationscountGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: basicAuth)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

WebhookConfigurationsApi *apiInstance = [[WebhookConfigurationsApi alloc] init];

// Retrieves the number of webhook configurations.
[apiInstance webhookConfigurationscountGetWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var WebhookConfigurationServiceApi = require('webhook_configuration_service_api');
var defaultClient = WebhookConfigurationServiceApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new WebhookConfigurationServiceApi.WebhookConfigurationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.webhookConfigurationscountGet(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class webhookConfigurationscountGetExample
    {
        public void main()
        {
            // Configure HTTP basic authorization: basicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new WebhookConfigurationsApi();

            try
            {
                // Retrieves the number of webhook configurations.
                'String' result = apiInstance.webhookConfigurationscountGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhookConfigurationsApi.webhookConfigurationscountGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\ApiWebhookConfigurationsApi();

try {
    $result = $api_instance->webhookConfigurationscountGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhookConfigurationsApi->webhookConfigurationscountGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WebhookConfigurationsApi;
# Configure HTTP basic authorization: basicAuth
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::WebhookConfigurationsApi->new();

eval { 
    my $result = $api_instance->webhookConfigurationscountGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhookConfigurationsApi->webhookConfigurationscountGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.WebhookConfigurationsApi()

try: 
    # Retrieves the number of webhook configurations.
    api_response = api_instance.webhook_configurationscount_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhookConfigurationsApi->webhookConfigurationscountGet: %s\n" % e)

Parameters

Responses

Status: 200 - A success response displaying the total count of WebhookConfigurations.