1. Integrating with Oracle Commerce
  2. Integrate with Oracle CPQ
  3. Set Up OIC Integrations
  4. Configure Commerce webhooks

Configure 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 the activation of the OIC integration can be configured as webhooks in Commerce Administration. These include the following:

  • Request Quote: This webhook is triggered when a request or a re-request for a quote is submitted by a Commerce self-service user. The 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 or rejected or the quote order is canceled by the Commerce self-service user. This webhook pushes notifications using the OCCS-CPQ Update Quote integration flow.
  • External Price Validation: This webhook is triggered at check out when the order contains one or more items configured by Oracle Configure, Price, Quote. The webhook validates the configuration and the price provided for configured items.
  • Contact Accounts Retrieval: This webhook returns a list of service account IDs for the shopper.

    Note: This webhook has been deprecated.

  • Services Retrieval: This webhook returns information about a service or asset associated with the shopper and uses the OCCS-CPQ Get Assets integration flow. This webhook calls the Contact Accounts Retrieval webhook, so that webhook must also be configured for the Services Retrieval webhook to function correctly.

    Note: This webhook has been deprecated.

Note: Administrators must configure the Production and Preview versions of the webhooks to ensure they work in all environments. The Production webhooks send information from the live Commerce store to the production environments of your live systems. The Preview webhooks send information from the preview environment to the test or sandbox environments of external systems.

To configure Request Quote, Update Quote, External Price Validation, Services Retrieval (deprecated), or Services (deprecated) webhooks:

  1. Log in to OIC as an admin user.
  2. Click the Integrations icon.
  3. Click the Integration Details icon to display information about the integration flow.
    • If configuring the Request Quote webhook, display information for the OCCS-CPQ Create Quote integration flow.
    • If configuring the Update Quote webhook, display information for the OCCS-CPQ Update Quote integration flow.
    • If configuring the External Price Validation webhook, display information for the OCCS-CPQ GetConfigurations integration flow.
    • If configuring the Services Retrieval webhook, display information for the OCCS-CPQ Get Assets integration flow.

      Note: This webhook has been deprecated.

    • If configuring the Services webhook, display information for the OCCS-CPQ Asset Actions integration flow.

    Note: This webhook has been deprecated.

  4. Copy the Endpoint URL for the integration.
  5. Log in to Commerce.
  6. Click on the Menu icon.
  7. Select Settings from the menu.
  8. Select Web APIs from the sidebar menu.
  9. Click the webhook you want to configure.
  10. Paste the Endpoint URL that was copied into the URL field for the webhook.
  11. Remove the “metadata” text from the end of the URL.
  12. Enter your OIC user name and password.
  13. Click Save.

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.

Understand the Services SSE

The Services SSE enables integration with third party asset management systems to retrieve and execute operations available to a shopper. This SSE also serves as the API for the integration with Oracle Configure, Price, Quote asset management.

The Modify, Renew, Terminate, Suspend, Resume, and Upgrade actions performed on a service or asset are done using the Services SSEs (server side extensions); one set for Storefront and one for Agent.

The Services SSEs call the integrations in OCCS_CPQ_ASSET_INTEGRATION_X.X.par and OCC_CPQ_Get_Asset_Upgrade_Options_X.X.par for the asset Upgrade feature.

See the section Configure the Commerce Server Side Extensions in this document for more information on these actions.

For more information about Commerce webhooks, refer to the Use Webhooks chapter of the Extending Oracle Commerce book.

For more information on understanding and using the asset Upgrade feature, refer to the Use Asset Based Ordering section of the Using Oracle Configure, Price, Quote Features with Oracle Commerce book.

Note: You can also customize configurations of complex assets in Commerce without being redirected to an Oracle Configure, Price, Quote hosted iFrame which may have a separate and distinct user interface look and feel that creates a disjointed user experience. This capability is known as the Direct API Configuration feature and can be used as another option for the Modify and Upgrade actions. For more information on the Direct API configuration feature, refer to the Customize configurations in Commerce using the Oracle Configure, Price, Quote Configuration API section of Use Oracle CPQ Cloud Features.