mirror of
https://github.com/directus/directus.git
synced 2026-02-12 01:54:55 -05:00
c4ae4b66cc
* Rename button-links->presentation-links * Rename checkboxes->select-multiple-checkbox * Rename code->input-code * Rename checkboxes files * Rename color->select-color * Rename divider->presentation-divider * Rename dropdown-multiselect->select-multiple-dropdown * Rename hash->input-hash * Rename icon->select-icon * Rename image->file-image * Rename m2a-builder->list-m2a * Rename many-to-many->list-m2m * Rename many-to-one->select-dropdown-m2o * Rename markdown->input-rich-text-md * Rename notice->presentation-notice * Rename one-to-many->list-o2m * Rename radio-buttons->select-radio * Rename repeater->list * Rename text-input->input * Rename textarea->input-multiline * Rename toggle->boolean * Rename tree-view->list-o2m-tree-view * Rename wysiwyg->input-rich-text-html * Use correct interfaces in system defaults * Rename collection->system-collection * Rename collections->system-collections * Rename display-template->system-display-template * Rename field->system-field * Rename interface->system-interface * Rename interface-options->system-interface-options * Rename scope->interface-scope * Rename tfa-setup->system-mfa-setup * Fix oversights * Remove old todo * Some more tweaks * Add migration, fix dropdown name in system use * Merge numeric + input * Replace dropdown->select-dropdown in app use * Merge slug->input, user->select-dropdown-m2o * Fix type issue * Fix seeder field name
93 lines
2.7 KiB
YAML
93 lines
2.7 KiB
YAML
get:
|
|
summary: Retrieve a Webhook
|
|
description: Retrieve a single webhook by unique identifier.
|
|
operationId: getWebhook
|
|
responses:
|
|
'200':
|
|
description: Successful request
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
data:
|
|
$ref: '../../openapi.yaml#/components/schemas/Webhooks'
|
|
'401':
|
|
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
|
'404':
|
|
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
|
tags:
|
|
- Webhooks
|
|
|
|
patch:
|
|
summary: Update a Webhook
|
|
description: Update an existing webhook
|
|
operationId: updateWebhook
|
|
parameters:
|
|
- $ref: '../../openapi.yaml#/components/parameters/Fields'
|
|
- $ref: '../../openapi.yaml#/components/parameters/Meta'
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
name:
|
|
description: The name of the webhook.
|
|
type: string
|
|
example: create articles
|
|
method:
|
|
description: Method used in the webhook.
|
|
type: string
|
|
example: POST
|
|
url:
|
|
description: The url of the webhook.
|
|
type: string
|
|
example: null
|
|
status:
|
|
description: The status of the webhook.
|
|
type: string
|
|
example: active
|
|
data:
|
|
description: If yes, send the content of what was done
|
|
type: boolean
|
|
example: true
|
|
actions:
|
|
description: The actions that triggers this webhook.
|
|
example: null
|
|
system-collections:
|
|
description: The collections that triggers this webhook.
|
|
example: null
|
|
type: object
|
|
responses:
|
|
'200':
|
|
description: Successful request
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
data:
|
|
$ref: '../../openapi.yaml#/components/schemas/Roles'
|
|
'401':
|
|
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
|
'404':
|
|
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
|
tags:
|
|
- Webhooks
|
|
|
|
delete:
|
|
summary: Delete a Webhook
|
|
description: Delete an existing webhook
|
|
operationId: deleteWebhook
|
|
responses:
|
|
'200':
|
|
description: Successful request
|
|
'401':
|
|
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
|
|
'404':
|
|
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
|
|
tags:
|
|
- Webhooks
|
|
parameters:
|
|
- $ref: '../../openapi.yaml#/components/parameters/UUId'
|