Merge pull request AdobeDocs#384 from AdobeDocs/revise-webhooks

Badging for webhooks

Author: keharper

src/data/navigation/sections/webhooks.js

@@ -50,15 +50,15 @@ module.exports = [
       ]
     },
     {
-      title: "Manage webhooks from the Admin",
+      title: "Create a webhook",
       path: "/webhooks/create-webhooks.md"
     },
     {
-      title: "Configure hooks",
+      title: "Configure hook contents",
       path: "/webhooks/hooks.md"
     },
     {
-      title: "Create conditional webhooks",
+      title: "Define conditional webhooks",
       path: "/webhooks/conditional-webhooks.md"
     },
     {

src/pages/webhooks/commands.md

@@ -1,6 +1,7 @@
 ---
 title: Webhooks commands
 description: Provides details about the commands needed to use Adobe Commerce webhooks.
+edition: paas
 keywords:
   - Extensibility
 ---

src/pages/webhooks/conditional-webhooks.md

@@ -1,12 +1,12 @@
 ---
-title: Create conditional webhooks
+title: Define conditional webhooks
 description: Learn how to create conditional webhooks, which can reduce the amount of remote API calls.
 keywords:
   - Webhooks
   - Extensibility
 ---
 
-# Create conditional webhooks
+# Define conditional webhooks
 
 You may decide that you want to trigger a webhook only if its payload meets certain conditions. For example, you could decide to calculate taxes using a third-party service for specific postal codes only. If the postal code provided in the payload does not match the selected postal code, there is no value in triggering the webhook.
 
@@ -33,18 +33,22 @@ Conditional webhooks can have one or more rules. Each rule contains the followin
 
 *  The value to compare against. When you assign the `regex` operator, you must delimit the regular expression value with valid characters, such as forward slashes (/). For example, `/^TV .*/i`, which checks whether the string starts with `TV`, ignoring the case of the letters.
 
-## Define conditional webhooks in `webhooks.xml`
+## Example: Calculate tax
 
 The following example creates and registers a conditional webhook for the event `plugin.magento.tax.api.tax_calculation.calculate_tax`. The webhook will be only triggered when all of the conditions are true:
 
 *  The value of `quoteDetails.shipping_address.country_id` must be equal to `US`.
 *  The `quoteDetails.billing_address.postcode` must begin with `123`.
 
+<CodeBlock slots="heading, code" repeat="2" languages="XML, YAML" />
+
+#### webhooks.xml (PaaS)
+
 ```xml
 <method name="plugin.magento.tax.api.tax_calculation.calculate_tax" type="after">
    <hooks>
       <batch name="Order_Updates">
-         <hook name="update_order" url="{env:APP_URL}/calculate-taxes" method="POST" timeout="5000" softTimeout="1000" priority="300" required="false" fallbackErrorMessage="The taxes can not be calculated">
+         <hook name="update_order" url="{env:APP_URL}/calculate-taxes" method="POST" timeout="5000" softTimeout="1000" priority="300" required="false" fallbackErrorMessage="The taxes cannot be calculated">
             <fields>
                <field name="quoteDetails" />
                <field name="storeId" />
@@ -59,8 +63,52 @@ The following example creates and registers a conditional webhook for the event
 </method>
 ```
 
+##### Admin (SaaS)
+
+```yaml
+Hook Settings
+
+Webhook method: plugin.magento.tax.api.tax_calculation.calculate_tax
+Webhook type: after
+Batch name: Order_Updates
+Hook name: update_order
+Hook priority: 300
+URL: <Host>/calculate-taxes
+Timeout: 5000
+Soft timeout: 1000
+Fallback Error Message: The taxes cannot be calculated
+Required: `false`
+Active: `true`
+
+Hook Fields
+
+Name: quoteDetails
+Active: Yes
+
+Name: storeId
+Active: Yes
+
+Hook Rules
+
+Name: quoteDetails.shipping_address.country_id
+Operation: equal
+Value: US
+Active: Yes
+
+Name: quoteDetails.billing_address.postcode
+Operation: regex
+Value: /^123/
+Active: Yes
+```
+
+## Example: Generate short descriptions for products
+
 The following example sends a webhook to a third-party service when the product short description is empty. The service generates the text for the description. The webhook returns the operation with information to update the product short description. As a result, the webhook will not be triggered again for the same product.
 
+<CodeBlock slots="heading, code" repeat="2" languages="XML, YAML" />
+
+#### webhooks.xml (PaaS)
+
 ```xml
        <method name="observer.catalog_product_save_before" type="before">
        <hooks>
@@ -80,6 +128,46 @@ The following example sends a webhook to a third-party service when the product
    </method>
 ```
 
+#### Admin (SaaS)
+
+```yaml
+Hook Settings
+
+Webhook method: observer.catalog_product_save_before
+Webhook type: before
+Batch name: Product_Updates
+Hook name: generate_description
+Hook priority: 300
+URL: <Host>/generate-product-description
+Timeout: 5000
+Soft timeout: 1000
+Fallback Error Message: The product could not be updated
+Required: `true`
+Active: `true`
+
+Hook Fields
+
+Name: product.name
+Source: data.product.name
+Active: Yes
+
+Name: product.category_ids
+Source: data.product.category_ids
+Active: Yes
+
+Name: product.sku
+Source: data.product.sku
+Active: Yes
+
+Hook Rules
+
+Name: product.short_description
+Operation: isEmpty
+Active: Yes
+```
+
 ## Command line
 
+<Edition name="paas" />
+
 You can use the `bin/magento webhooks:list` command to display the contents of your subscribed webhooks, including rules information.