cloudblue · munashige · May 17, 2022 · May 31, 2022 · May 31, 2022 · May 31, 2022
diff --git a/modules.json b/modules.json
@@ -48,7 +48,8 @@
             "description": "Create and manage access tokens, define webhooks, and learn more about extensions with the Integrations Management module.",
             "icon": "power",
             "objects":[
-                "api-tokens/object.json"
+                "api-tokens/object.json",
+                "webhooks/object.json"
             ]
         },
         "Hubs": {

diff --git a/webhooks/object.html b/webhooks/object.html
@@ -0,0 +1,35 @@
+<html>
+<head>
+<style>
+</style>
+<meta charset="utf-8">
+    <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
+    <script type='text/javascript' src='http://davidlynch.org/projects/maphilight/jquery.maphilight.js'></script>
+    <script type="text/javascript">
+        $(document).ready(function () {
+            $('.map').maphilight({ alwaysOn: true });
+            // uncomment this line for normal hover highlighting
+            // $('.map').maphilight();
+        });   
+    </script>
+</head>
+<body>
+
+<!-- Edit with https://summerstyle.github.io/summer/ below -->
+
+<img class="map" src="object.png" alt="" usemap="#map" />
+<map name="map">
+    <area shape="rect" coords="1958, 1462, 2215, 1628" href="t-6-enab-deleted" />
+    <area shape="rect" coords="905, 1449, 1171, 1630" href="t-5-dis-deleted" />
+    <area shape="rect" coords="1429, 360, 1713, 502" href="t-3-enab-disabled" />
+    <area shape="rect" coords="1854, 769, 2352, 1196" href="s-a-enabled" />
+    <area shape="rect" coords="1438, 808, 1704, 965" href="t-2-dis-enabled" />
+    <area shape="rect" coords="783, 763, 1296, 1182" href="s-a-disabled" />
+    <area shape="rect" coords="862, 2, 1346, 167" href="t-4-new-enabled" />
+    <area shape="rect" coords="332, 811, 768, 951" href="t-1-new-disabled" />
+</map>
+
+<!-- Edit with https://summerstyle.github.io/summer/ above -->
+
+</body>
+</html>
diff --git a/webhooks/object.json b/webhooks/object.json
@@ -0,0 +1,101 @@
+{
+    "name": "Webhooks",
+    "image": "object.png",
+    "readme": "object.md",
+        "statuses": [
+            {
+                "id": "s-a-disabled",
+                "name": "Disabled",
+                "mapping": {
+                    "left": "32.14%",
+                    "top": "43.52%",
+                    "width": "21.17%",
+                    "height": "25.34%"
+                }
+            },
+            {
+                "id": "s-b-enabled",
+                "name": "Enabled",
+                "mapping": {
+                    "left": "75.87%",
+                    "top": "43.86%",
+                    "width": "21.17%",
+                    "height": "25.34%"
+                }
+            }
+        ],
+        "transitions": [
+            {
+                "id": "t-1-new-disabled",
+                "from": "New",
+                "to": "Disabled",
+                "name": "1. Webhook Creation",
+                "mapping": {
+                    "left": "13.48%",
+                    "top": "45.24%",
+                    "width": "18.17%",
+                    "height": "10.32%"
+                }
+            },
+            {
+                "id": "t-2-dis-enabled",
+                "from": "Disabled",
+                "to": "Enabled",
+                "name": "2. Webhook Activation",
+                "mapping": {
+                    "left": "58.53%",
+                    "top": "45.3%",
+                    "width": "12.86%",
+                    "height": "10.32%"
+                }
+            },
+            {
+                "id": "t-3-enab-disabled",
+                "from": "Enabled",
+                "to": "Disabled",
+                "name": "3. Webhook Deactivation",
+                "mapping": {
+                    "left": "58.12%",
+                    "top": "19.84%",
+                    "width": "12.86%",
+                    "height": "10.32%"
+                }
+            },
+            {
+                "id": "t-4-new-enabled",
+                "from": "New",
+                "to": "Enabled",
+                "name": "4. Enabled Webhook Creation",
+                "mapping": {
+                    "left": "36.29%",
+                    "top": "0.17%",
+                    "width": "17.88%",
+                    "height": "10.32%"
+                }
+            },
+            {
+                "id": "t-5-dis-deleted",
+                "from": "Disabled",
+                "to": "Deleted",
+                "name": "5. Disabled Webhook Removal",
+                "mapping": {
+                    "left": "36.42%",
+                    "top": "83.37%",
+                    "width": "12.86%",
+                    "height": "10.32%"
+                }
+            },
+            {
+                "id": "t-6-enab-deleted",
+                "from": "Enabled",
+                "to": "Deleted",
+                "name": "6. Enabled Webhook Removal",
+                "mapping": {
+                    "left": "80.56%",
+                    "top": "83.54%",
+                    "width": "11.8%",
+                    "height": "10.32%"
+                }
+            }
+        ]
+    }
diff --git a/webhooks/object.md b/webhooks/object.md
@@ -0,0 +1,8 @@
+# Webhooks
+## Overview
+Webhooks represent objects on CloudBlue Connect that allow platform users to define HTTP callbacks. Such callbacks are triggered by your selected event within the system. Namely, your defined webhook can be triggered if your request queue is changed, in case your draft or inquiring requests require validation, and so on. Once your specified event is occurred, the webhook sends corresponding *GET* or *POST* request to your provided endpoint URL. Therefore, webhooks can drastically facilitate the communication between the Connect platform and any web application that can accept HTTP requests.
+
+It is also important to note that your webhooks on the Connect platform can also include headers with your provided *keys* with *values* and arbitrary JSON object that is appended to your token as the *.data* property.
+## Learn more
+Refer to the [Webhooks documentation](https://connect.cloudblue.com/community/modules/extensions/webhooks/) to learn how to create and manage your webhooks.  
+It is also recommended to get familiar with the [Dynamic Parameters Validation use case](https://connect.cloudblue.com/community/modules/subscriptions/user-interface/dynamic-validation/) that provides an example of a webhook for pre-provisioning request validation.
diff --git a/webhooks/object.png b/webhooks/object.png
diff --git a/webhooks/object.pptx b/webhooks/object.pptx
diff --git a/webhooks/s-a-disabled.md b/webhooks/s-a-disabled.md
@@ -0,0 +1,14 @@
+# Disabled Status
+## Description
+The *Disabled* status implies that your webhook is switched off and it will not provide any HTTP callbacks. This status can be assigned to a new webhook object in case the corresponding option is selected. Once your enabled webhook is turned off, the system also assigns the *Disabled* status to your webhook.  
+Disabled webhooks can be enabled or removed if necessary.
+## Prerequisites 
+A new webhook object with the selected **Disabled** option.  
+Alternatively, a webhook object in the [Enabled](s-b-enabled.html) state that should be deactivated.
+## Transferable statuses
+Once your webhook is successfully activated, it is assigned to the [Enabled](s-b-enabled.html) state.
+## Associated transitions
+* [Webhook Creation](t-1-new-disabled.html)
+* [Webhook Activation](t-2-dis-enabled.html)
+* [Webhook Deactivation](t-3-enab-disabled.html)
+* [Disabled Webhook Removal](t-5-dis-deleted.html)
diff --git a/webhooks/s-a-disabled.png b/webhooks/s-a-disabled.png
diff --git a/webhooks/s-b-enabled.md b/webhooks/s-b-enabled.md
@@ -0,0 +1,14 @@
+# Enabled Status
+## Description
+The *Enabled* status indicates that your webhook is switched on. Therefore, your webhook will provide required HTTP callbacks for your specified events within the system. This status can be assigned to a new webhook object in case the **Enabled** switch is activated. In case disabled webhooks are activated, the system also assigns the *Enabled* status to such webhook.  
+Enabled webhooks can be deactivated or deleted if necessary.
+## Prerequisites 
+A new webhook object with the selected **Enabled** option.  
+Alternatively, a webhook object in the [Disabled](s-a-disabled.html) state that should be activated.
+## Transferable statuses
+In case your webhook is deactivated, the system assigns it to the [Disabled](s-a-disabled.html) state.
+## Associated transitions
+* [Webhook Activation](t-2-dis-enabled.html)
+* [Webhook Deactivation](t-3-enab-disabled.html)
+* [Enabled Webhook Creation](t-4-new-enabled.html)
+* [Enabled Webhook Removal](t-6-dis-deleted.html)
diff --git a/webhooks/s-b-enabled.png b/webhooks/s-b-enabled.png
diff --git a/webhooks/t-1-new-disabled.md b/webhooks/t-1-new-disabled.md
@@ -0,0 +1,7 @@
+# Webhook Creation
+## Description
+This transition indicates that a new webhook object with the selected *Disabled* option is being generated on the CloudBlue Connect platform. Note that the functionality your defined webhook will not be available until it is assigned to the following status. 
+## Prerequisites
+The *Disabled* option during the webhook creation is selected.
+## Operation results
+A webhook object in the [Disabled](s-a-disabled.html) state.
diff --git a/webhooks/t-1-new-disabled.png b/webhooks/t-1-new-disabled.png
diff --git a/webhooks/t-2-dis-enabled.md b/webhooks/t-2-dis-enabled.md
@@ -0,0 +1,7 @@
+# Webhook Activation
+## Description
+Once platform users activate their webhooks on CloudBlue Connect, the system transfers such webhooks to the *Enabled* status. Therefore, the functionality of your webhook will be available for your specified events.
+## Prerequisites
+A webhook object in the [Disabled](s-a-disabled.html) state.
+## Operation results
+A webhook object in the [Enabled](s-b-enabled.html) state.
diff --git a/webhooks/t-2-dis-enabled.png b/webhooks/t-2-dis-enabled.png
diff --git a/webhooks/t-3-enab-disabled.md b/webhooks/t-3-enab-disabled.md
@@ -0,0 +1,7 @@
+# Webhook Deactivation
+## Description
+This transition indicates that your webhook is being deactivated on the Connect platform. As a result, the system assigns the *Disabled* status to your webhook and its functionality will not available. Note that the system also allows reactivating disabled webhooks.
+## Prerequisites
+A webhook object in the [Enabled](s-b-enabled.html) state.
+## Operation results
+A webhook object with the [Disabled](s-a-disabled.html) status.
diff --git a/webhooks/t-3-enab-disabled.png b/webhooks/t-3-enab-disabled.png
diff --git a/webhooks/t-4-new-enabled.md b/webhooks/t-4-new-enabled.md
@@ -0,0 +1,7 @@
+# Enabled Webhook Creation
+## Description
+This transition indicates that a new webhook object with the selected *Enabled* option is being generated on the CloudBlue Connect platform. Therefore, the functionality your defined webhook will be enabled successfully and it will provide required callbacks upon your selected events.
+## Prerequisites
+The *Enabled* option during the webhook creation is selected.
+## Operation results
+A webhook object in the [Enabled](s-b-enabled.html) state.
diff --git a/webhooks/t-4-new-enabled.png b/webhooks/t-4-new-enabled.png
diff --git a/webhooks/t-5-dis-deleted.md b/webhooks/t-5-dis-deleted.md
@@ -0,0 +1,7 @@
+# Disabled Webhook Removal
+## Description
+This transition implies that your disabled webhook is being removed. Note that removed webhooks objects cannot be restored. Thus, in case your webhook functionality is required again, it is necessary to create and configure a new webhook object on the platform.
+## Prerequisites
+A webhook object in the [Disabled](s-a-disabled.html) state.
+## Operation results
+A deleted webhook object.
diff --git a/webhooks/t-5-dis-deleted.png b/webhooks/t-5-dis-deleted.png
diff --git a/webhooks/t-6-enab-deleted.md b/webhooks/t-6-enab-deleted.md
@@ -0,0 +1,7 @@
+# Disabled Webhook Removal
+## Description
+This transition implies that your enabled webhook is being deleted. Removed webhooks objects cannot be used or restored. Thus, in case your webhook functionality is required once again, it is necessary to create and configure a new webhook object within the system.
+## Prerequisites
+A webhook object with the [Enabled](s-b-enabled.html) status.
+## Operation results
+A deleted webhook object.
diff --git a/webhooks/t-6-enab-deleted.png b/webhooks/t-6-enab-deleted.png