chore: Update the documentation for configuring webhooks in the account (#4703)
This commit is contained in:
19
swagger/paths/application/webhooks/create.yml
Normal file
19
swagger/paths/application/webhooks/create.yml
Normal file
@@ -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
|
||||
12
swagger/paths/application/webhooks/delete.yml
Normal file
12
swagger/paths/application/webhooks/delete.yml
Normal file
@@ -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
|
||||
15
swagger/paths/application/webhooks/index.yml
Normal file
15
swagger/paths/application/webhooks/index.yml
Normal file
@@ -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
|
||||
19
swagger/paths/application/webhooks/update.yml
Normal file
19
swagger/paths/application/webhooks/update.yml
Normal file
@@ -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
|
||||
Reference in New Issue
Block a user