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

swagger/definitions/index.yml

@@ -36,6 +36,8 @@ contactable_inboxes:
   $ref: ./resource/contactable_inboxes.yml
 custom_filter:
   $ref: ./resource/custom_filter.yml
+webhook:
+  $ref: ./resource/webhook.yml
 account:
   $ref: ./resource/account.yml
 platform_account:
@@ -91,6 +93,9 @@ team_create_update_payload:
 custom_filter_create_update_payload:
   $ref: ./request/custom_filter/create_update_payload.yml
 
+webhook_create_update_payload:
+  $ref: ./request/webhooks/create_update_payload.yml
+
 integrations_hook_create_payload:
   $ref: ./request/integrations/hook_create_payload.yml
 
@@ -158,6 +163,3 @@ account_summary:
   $ref: './resource/reports/summary.yml'
 agent_conversation_metrics:
   $ref: './resource/reports/conversation/agent.yml'
-
-
-

swagger/definitions/request/webhooks/create_update_payload.yml

@@ -0,0 +1,18 @@
+type: object
+properties:
+  url:
+    type: string
+    description: The url where the events should be sent
+  subscriptions:
+    type: array
+    items:
+      type: string
+      enum: [
+        "conversation_created",
+        "conversation_status_changed",
+        "conversation_updated",
+        "message_created",
+        "message_updated",
+        "webwidget_triggered"
+      ]
+    description: The events you want to subscribe to.

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