Sitecore XMCloud Webhooks events notitications

-

In Sitecore XMCloud different kinds of events will be get notified with the 3rd party system using the API endpoint, this helps the 3rd party system to do necessary action based on the information received from the webhook events triggered from XMCloud.

There are 3 kinds of webhooks we can get notifications from.

  • Webhook Event handler
  • Webhook Submit action
  • Webhook validation action.
Webhook Events handler:
This webhook is used to provide notifications from XMCloud for the following events, We are not limited to using only the out-of-box events, we can create our custom events and get notifications from them.

     Webhooks can be set to trigger on certain rules that we can set in XMCloud, once the Rule is met then this webhook will be triggered to provide notification on the defined API endpoint.

Webhook Submit action

This Webhook submit action is set at the workflow level, either from moving from one state to another state or from the command level or as an action.
Once this webhook is enabled the necessary information about the item that is passed to 3rd party system to do necessary action on it, like cache purge, notification email, etc.


Webhook Validation action:

This Webhook validation action is also set at the workflow level only, but there is a difference between the Webhook submit action and this.

This Webhook Validation action expects the approval from the 3rd party system to either approve the content with the changes or reject it, based on API system response XMCloud will move the item to its next workflow state if the response does not come back due to an error from the API system XMCloud will not move the item next workflow state.

The response format expected by the XMCloud is {"IsValid":true,"Message":""}

Fields Available in Webhook Template:
Types of Authorization:



Steps to enable Webhook in XMCloud and preview the request response in the 3rd party API System

  • Webhooks Events Handler needs to be created in the following path /sitecore/system/Webhooks
  • Webhook Submit action / Webhook Validation needs to be created in workflow state/command
  • After setting all the necessary fields and enabled the Webhook, then we can capture the data in the API system like below.
  • In the below screen shot I have saved the Home item from xmcloud with some fields updated which triggers the Webhook Event handler based on the Rule I have defined in it.
  • The event got captured in the API system to the endpoint mapped in the URL field.
  • The response is captured by API system and it will process according to the business needs.

Webhook Events Handler Request:
        

Webhook Validation Action  request:

         If the Webhook Validation action is set for moving from one state to another then it should 
         receive the response from 3rd party system. Sometimes the API request will fail due to a 
        timeout issue, we can increase our timeout by patching the config setting                                                Sitecore.HttpClientTimeout.

        


On approving the workflow state this Webhook will get triggered, and it will wait for the response from the API end to move to the next state.

Webhook Submit Action Request:

This webhook will trigger on the state and command level based on our workflow configuration.


Happy Programming 😊

Comments

Post a Comment

Popular posts from this blog

Custom Item Url and resolving the item in Sitecore - Buckets

-
Image
I have a situation to update the Item URL to be SEO friendly as my items in content tree looks like below. In the above image in order to resolve the item, Sitecore will find the item from the below URL http://domainname/en/dine/nv/chicken but I need to form a URL that is more SEO friendly like http://domainname/en/chicken In Sitecore by Out of box, we can achieve this by using Aliases , we can create an Aliases under System à Aliases and in the Linked Item field select the target item. But this is very tedious as we need to go to every item in the content tree and create Aliases, instead of that we will be going to do it programmatically using custom pipelines. ·          Link Provider (Provides the custom URL for the item based on the templates) ·          Item Resolver (Resolves the item based on the custom URL generated by CustomLinkProvider , that we going to create later. Sitecore could not resolve the item in the specified path in the content tree
Read more

Exploring Sitecore XM Cloud Forms: A Comprehensive Overview

-
Image
  The most awaited news came from Sitecore about the release of XM Cloud Forms.  Previously Sitecore enthusiasts / Marketers used different ways of forms implementation in Sitecore to reach the target customers like WFFM (Web Form For Marketers) Sitecore Forms Embeddable Forms Framework(EFF) XM Cloud Form is the latest addition by Sitecore and especially used to create Forms on XM Cloud pages. It will only work with the latest version of Sitecore JSS (21.6) Note:  I have tried to use XM Cloud Forms in my local docker setup by cloning the starter   repo , but I couldn't see the option of Forms in the XM Cloud dashboard to get started. Lets explore together on the features of Forms. Similar to Sitecore Components, we can navigate to  https://forms.sitecorecloud.io/  to start creating the Forms There are 2 important tabs in creating Sitecore Forms  Forms  Webhook(for triggering the submit action) We can create, modify, delete, and activate the form from the Form tab.  Once the form is
Read more

Sitecore Custom Rule (Action and Condition)

-
Image
I have a situation to create a custom Sitecore rule and action for it. v   Goto /Sitecore/system/Settings/Rules/Definitions/Elements v   Create a new item base on the template “ ElementFolder ” with a name “ Custom Rule ” v   Click on the item and create condition and Actions that are necessary for your requirements Condition Template Item: It has two important sections v   Data ·          Text (This is the condition Text which will use tokens to evaluate the condition and user input which will be in [ ] brackets.The brackets contain four positional parameters separated by commas (“,”). 1. The name of the property that the parameter sets in the .NET class that implements the condition. 2. The name of an item beneath the /Sitecore/System/Settings/Rules/Common/Macros item providing predefined functionality, or an empty string. For example, to activate a user interface allowing the user to select an item from the content tree, specify the value tree. 3. URL param
Read more