chore: Update the documentation for configuring webhooks in the account (#4703)

2022-05-19 21:43:23 +05:30
parent 8538660bbd
commit 11ea8a3032
12 changed files with 340 additions and 18 deletions
--- a/swagger/definitions/resource/webhook.yml
+++ b/swagger/definitions/resource/webhook.yml
@@ -0,0 +1,24 @@
+type: object
+properties:
+  id:
+    type: number
+    description: The ID of the webhook
+  url:
+    type: string
+    description: The url to which the events will be send
+  subscriptions:
+    type: array
+    items:
+      type: string
+      enum: [
+        "conversation_created",
+        "conversation_status_changed",
+        "conversation_updated",
+        "message_created",
+        "message_updated",
+        "webwidget_triggered"
+      ]
+    description: The list of subscribed events
+  account_id:
+    type: number
+    description: The id of the account which the webhook object belongs to