Name: Introducing Webhooks in SAP Commerce Cloud
Uploaded: 2021-7-29
Duration: 549 s
Description: This videos presents a short introduction to Webhooks and shows how to configure and smoke test in SAP Commerce Cloud.

Share feedback

<p><u><strong>Planned maintenance of Practice Systems</strong></u></p>

Planned maintenance of Practice Systems

Why create an SAP account?

Enhance your learning experience

SAP Learning

Choose your subscription

Manage your subscription

Live Sessions

Hands-on Practice

Certification

My Learning

Ready to start learning?

<div><div><div><div>This videos presents a short introduction to Webhooks and shows how to configure and smoke test in SAP Commerce Cloud.</div></div></div></div>

Introducing Webhooks in SAP Commerce Cloud

Hi, my name is Carlos and I am part of SAP's Customer Experience team. In this video we will learn more about this new feature in SAP Commerce Cloud Platform called webhooks. I'll show you why webhooks are an important feature to have when integrating to external platforms. Then I will show you a brief demo on how to create and configure webhooks in SAP Commerce Cloud. And finally, I will share some basic tips to a smoke test our webhooks as an initial assessment to validate its configuration. So why webhooks? Let's say a customer is confirming an order on my site, or that I am enriching product data as a business user and I want external systems to be aware of these changes. Starting on SAP Commerce Cloud version 2011, we can use webhooks to send a notification when an item is either created or updated in the platform. For instance, we can send an external notification every time a new order is created. When a product is updated, and so on. So when an item is created or updated in SAP Commerce, Cloud webhooks allow the platform to send notifications to a configured destination URL. These notifications are sent in response to after save events for the specific item types. The platform will look up the list of webhook configurations to see which integration object can support the saved item for each applicable webhook configuration. Commerce will send the payload to the destination URL specified on that configuration. With webhooks, you can better capture and manage activities that are taking place in the SAP Commerce Cloud platform. The best part? Webhooks can be configured at runtime. This means no additional code required and no downtime. Now we will talk about how to configure webhooks in SAP Commerce Cloud. Before any webhook notification is sent, we must create a webhook configuration. The webhook configuration consists of two required pieces of information. The integration object or IO, which defines the notification payload, and a consume destination which specifies the URL. Notifications should be sent to. As a side note, it's important to mention the IO also defines which route item is supported by this particular webhook configuration. Now I'm going to jump to a brief demo on how to create and configure webhooks. First I'll create a consumer destination. Then I'll create an integration object or IO to define the payload. Next I'll create a new webhook configuration and assign the IO and the consume destination to it. Finally, I'll test the integration using an external monitoring site. So let's jump right in. I'm in the administration cockpit perspective of back office. And to use webhooks, the first thing I need to do is to create a consumer destination. So I am filtering the option over here for consumed destination. I'm going to click on the plus sign. And then I'm going to fill the mandatory values. So for ID I'm going to put something like my orders destination. And what I'm going to use as destination URL is a webhook site URL. This is with the intention of simulating the destination system, using a dummy URL. So I'm going to copy this URL over here. I'm going to paste it here. So now this endpoint or destination is going to be my test destination for webhooks. I'm going to activate it for destination target. In the case of webhooks I'm going to select webhook services. And the endpoint is just a descriptive element. I don't really need to set anything in particular for this example, so I'm just going to select local hybris. The item is created and I see it over here. If I click in my orders destination configuration I see that over here I have this belt sign. So if I click on the bell what I'm going to do is I'm going to be able to pin the destination. So I'm going to click it. And if I go back to my webhook dot site UI, I'm going to see that I have a Get request on that endpoint. So this means the communication is working. The second point is I'm going to create an integration object. So I'm going to switch from the administration cockpit to the intuition UI tool. I'm going to click on modeling. I'm going to click on the plus sign in the modeling part. And I'm going to create my intuition object. So this is going to be my orders IO as route type. I'm going to select order. This means that every time an order is either created or updated, I am going to execute an event through my webhook configuration. Integration type is descriptive. We don't really need to fill it out for this example. So I'm going to create my IO. I have my integration object created. I'm going to select all the attributes that I want for my payload. So I'm going to select the code of the order. For example creation date modified time. The status of the order which is also important pricing total price, total discounts maybe. And the user that created that object. I'm going to save my integration object. And my payload definition is correctly configured. The third step is to configure the webhook. So I'm going to go to the section the last section in integration UI to choose webhooks. And I'm going to click on the plus sign to create a new configuration. So now everything here is quite straightforward. The integration object that I'm going to use is the one that I just created my orders how my consume destination is my orders destination. And for now we are not going to use any filter. So I'm going to create the webhook. I am going to execute an order in my Spartacus storefront. I have over here and product we the cost of one 46.88. I don't have any discounts it seems, and they have all my details already reviewed. So I'm going to place the order. So now if I jump back to my webhook, that site UI, I can see that I have a couple of new post requests over here. So the first one is my creation or my order creation, with all the elements that I selected from the attributes of the IO. I have another request over here, which adds, new status for the order, which is project, which means this new status updated the order and therefore executed a new event through my webhook. In addition to back office configuration, we can also configure webhooks at runtime through impact files and through the new webhooks meta API. The meta API allows creation of consume destinations and relate them with its corresponding entities. It also allows referencing existing Io's from the webhook configurations. The endpoint for the API slash webhook service, which is a reference we already made during the previous demo. An additional feature that is worth mentioning is item filtering for webhooks. Filters allow you to control which items are sent to a webhook and which ones are filtered out. You can create filters so only certain items are delivered based on their attribute values. This means you can filter events out of publication by applying a script based filter, to make sure only desired events are propagated. On the previous demo, we could have used filtering to not let two of the requests out of commerce until they were in the right state. One common method of testing and debugging Http requests is using an external monitoring site, like we did in this demo. Another tool that might help you is enabled monitoring for webhooks. To do this. Users should follow the same process as when enabling outbound sync monitoring. When monitoring is enabled. Requests from both webhook services and outbound sync will be captured in SAP Commerce Cloud Platform. For example, the outbound services that monitoring that enabled property can be set to true in Outbound Services Project Properties file to enable monitoring. It can also be set through the application console at runtime. Users can also configure payload retention with the properties shown at the bottom of this slide. That was it for this video. I hope it was really, really useful and see you next time.