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

swagger/paths/application/webhooks/create.yml

@@ -0,0 +1,19 @@
+tags:
+  - Webhooks
+operationId: create-a-webhook
+summary: Add a webhook
+description: Add a webhook subscription to the account
+parameters:
+  - $ref: '#/parameters/account_id'
+  - name: data
+    in: body
+    required: true
+    schema:
+      $ref: '#/definitions/webhook_create_update_payload'
+responses:
+  200:
+    description: Success
+    schema:
+      $ref: '#/definitions/webhook'
+  401:
+    description: Unauthorized

swagger/paths/application/webhooks/delete.yml

@@ -0,0 +1,12 @@
+tags:
+  - Webhooks
+operationId: delete-a-webhook
+summary: Delete a webhook
+description: Delete a webhook from the account
+responses:
+  200:
+    description: Success
+  401:
+    description: Unauthorized
+  404:
+    description: The webhook does not exist in the account

swagger/paths/application/webhooks/index.yml

@@ -0,0 +1,15 @@
+tags:
+  - Webhooks
+operationId: list-all-webhooks
+summary: List all webhooks
+description:  List all webhooks in the account
+responses:
+  200:
+    description: Success
+    schema:
+      type: array
+      description: 'Array of webhook objects'
+      items:
+        $ref: '#/definitions/webhook'
+  401:
+    description: Unauthorized

swagger/paths/application/webhooks/update.yml

@@ -0,0 +1,19 @@
+tags:
+  - Webhooks
+operationId: update-a-webhook
+summary: Update a webhook object
+description: Update a webhook object in the account
+parameters:
+  - $ref: '#/parameters/account_id'
+  - name: data
+    in: body
+    required: true
+    schema:
+      $ref: '#/definitions/webhook_create_update_payload'
+responses:
+  200:
+    description: Success
+    schema:
+      $ref: '#/definitions/webhook'
+  401:
+    description: Unauthorized

swagger/paths/index.yml

@@ -385,6 +385,23 @@
   delete:
     $ref: ./application/custom_filters/delete.yml
 
+# webhooks
+/api/v1/accounts/{account_id}/webhooks:
+  parameters:
+    - $ref: '#/parameters/account_id'
+  get:
+    $ref: ./application/webhooks/index.yml
+  post:
+    $ref: ./application/webhooks/create.yml
+/api/v1/accounts/{account_id}/webhooks/{webhook_id}:
+  parameters:
+    - $ref: '#/parameters/account_id'
+    - $ref: '#/parameters/webhook_id'
+  patch:
+    $ref: ./application/webhooks/update.yml
+  delete:
+    $ref: ./application/webhooks/delete.yml
+
 ### Reports
 
 # List