docs: Add documentation for integration APIs (#2300)

2021-05-20 20:46:45 +05:30
parent c681e8a01b
commit 46356d0bf9
23 changed files with 421 additions and 22 deletions
--- a/swagger/definitions/resource/integrations/hook.yml
+++ b/swagger/definitions/resource/integrations/hook.yml
@@ -0,0 +1,23 @@
+type: object
+properties:
+  id:
+    type: string
+    description: The ID of the integration hook
+  app_id:
+    type: string
+    description: The ID of the integration app
+  inbox_id:
+    type: string
+    description: Inbox ID if its an Inbox integration
+  account_id:
+    type: string
+    description: Account ID of the integration
+  status:
+    type: boolean
+    description: Whether the integration hook is enabled for the account
+  hook_type:
+    type: boolean
+    description: Whether its an account or inbox integration hook
+  settings:
+    type: object
+    description: The associated settings for the integration