Configure the Commerce Webhooks

You must configure webhooks in Commerce Administration in order to support the REST API generated by the activation of the OIC integration.

The REST API generated by activating the OIC integration can be configured as a Webhook in Commerce Administration. These webhooks include the following:

Request Quote: This webhook is triggered when a request or re-request for a quote is submitted by a Commerce self-service user. This webhook pushes notifications using the OCCS-CPQ Create Quote integration flow.
Update Quote: This webhook is triggered when a response to a requested quote is accepted, rejected, or the quote is canceled by a Commerce self-service user. This webhook pushes notifications using the OCCS-CPQ Update Quote integration flow.
External Price Validation: This webhook is triggered at checkout when the order contains one or more items configured by Oracle Configure, Price, Quote. This webhook should point to the SSE app URL configured later. The webhook validates the configuration and price provided for the configured items. It also includes the commerce item ID data in the request payload and updates the external price information of the commerce items. Finally, it invokes a re-pricing operation at order checkout.
Contact Accounts Retrieval: This webhook has been deprecated. The corresponding SSE endpoints are invoked from the widget. It returns a list of service account IDs for the shopper. Formerly, this webhook called the Contact Accounts Retrieval webhook, so that webhook also had to be configured for the Services Retrieval webhook to function correctly.
Services Retrieval: This webhook has been deprecated. The corresponding SSE endpoints are invoked from the corresponding widget. Formerly, this webhook returned information about a service or asset associated with the shopper and used the OCCS-CPQ Get Assets integration flow. This webhook called the Contact Accounts Retrieval webhook, so that webhook also had to be configured for the Services Retrieval webhook to function correctly.

You must configure the Production and Preview version of these webhooks to ensure that they work in all environments. The Production webhooks send information from your live store to production environments of your live systems, while preview webhooks send information from your preview environment to the test or sandbox environments of your external systems.

Follow these instructions to configure the Request Quote, Update Quote, External Price Validation, Services Retrieval, and Services webhooks:

Log on to OIC as an admin user.
Click on the Integrations icon.
Click on the Integration Details icon to display information about the integration flow.
- If you are configuring the Request Quote webhook, you should display information for the OCCS-CPQ Create Quote integration flow.
- If you are configuring the Update Quote webhook, you should display information for the OCCS-CPQ Update Quote integration flow.
- If you are configuring the External Price Validation webhook, you should display information for the OCCS-CPQ External Pricing integration flow. For this webhook, you to configure the SSE app endpoint.
- If you are configuring the Services Retrieval webhook, you should display information for the OCCS-CPQ Get Assets integration flow. This OIC flows requires the Services SSE to be set up and invoked from there.
- If you are configuring the Services webhook, you should display information for the OCCS-CPQ Asset Actions integration flow. This OIC flows requires the Services SSE to be set up and invoked from there.
Copy the Endpoint URL for the integration.
Log into Commerce.
Click the Menu icon.
Select Settings from the menu.
Select Web APIs from the sidebar menu.
Click the webhook you wish to configure.
Paste the Endpoint URL you copied into the URL field for the webhook.
Remove the “metadata” text from the end of the URL.
Enter the user name and Password for your OIC account.
Click the Save button.

The webhook is now configured and is triggered each time the relevant event occurs, which in turn triggers the relevant integration flow.

Note: It is not possible to edit webhooks differently for different sites. Updating webhooks applies changes regardless of the site selected.

For more information on Oracle Commerce webhooks, please refer to Configure webhooks.

Understand the Services SSE

Modify, renew, terminate, suspend, and resume actions performed on a service or asset are done using the Services server side extensions, one set for Storefront and one for Agent. Get Assets and Get Asset details are also performed using the endpoints in the Services SSE.

See the topic Use developer tools to customize your store for information.