From 2984d6876d4a17d851013ae078a65b10a98f9cee Mon Sep 17 00:00:00 2001
From: prafull-opensignlabs
 <93375423+prafull-opensignlabs@users.noreply.github.com>
Date: Fri, 9 Feb 2024 09:25:56 +0530
Subject: [PATCH] add event description in webhook

---
 docs/docs/API-docs/opensign.yaml | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/docs/docs/API-docs/opensign.yaml b/docs/docs/API-docs/opensign.yaml
index af65e5278..99efd5ed2 100644
--- a/docs/docs/API-docs/opensign.yaml
+++ b/docs/docs/API-docs/opensign.yaml
@@ -803,7 +803,25 @@ paths:
       tags:
       - Webhook
       summary: Get Webhook
-      description: The Get Webhook API allow you to get webhook url
+      description: |
+        The save or update Webhook API allow you to save webhook url which is used to trigger events
+        ### events:
+        
+        1. **viewed:**
+            - When signer view document this event will trigger.
+            
+        2. **created:**
+            - When document is created this event will trigger.
+            
+        3. **signed:**
+            - When document is signed by signer this event will trigger.
+
+        4. **completed:**
+            - When document is singed by signers this event will trigger.
+            
+        5. **declined:**
+            - When document is declined by signer this event will trigger.
+
       operationId: getWebhook
       responses:
         "200":