73 lines
1.7 KiB
Markdown
73 lines
1.7 KiB
Markdown
---
|
|
name: webhooks-routes
|
|
description: Handle 5 OpenAPI operation(s) under /api/webhooks for the webhooks route group.
|
|
---
|
|
|
|
# webhooks API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /api/webhooks for the webhooks route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### get_webhooks
|
|
|
|
- Operation ID: `get_webhooks`
|
|
- Route: `GET /api/webhooks`
|
|
- Mode: READ
|
|
- Summary: Get Webhooks
|
|
- Parameters:
|
|
- `fields[webhook-topic]` in `query`
|
|
- `fields[webhook]` in `query`
|
|
- `include` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### create_webhook
|
|
|
|
- Operation ID: `create_webhook`
|
|
- Route: `POST /api/webhooks`
|
|
- Mode: WRITE
|
|
- Summary: Create Webhook
|
|
- Parameters:
|
|
- `fields[webhook]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_webhook
|
|
|
|
- Operation ID: `get_webhook`
|
|
- Route: `GET /api/webhooks/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Webhook
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[webhook-topic]` in `query`
|
|
- `fields[webhook]` in `query`
|
|
- `include` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### update_webhook
|
|
|
|
- Operation ID: `update_webhook`
|
|
- Route: `PATCH /api/webhooks/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update Webhook
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[webhook]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_webhook
|
|
|
|
- Operation ID: `delete_webhook`
|
|
- Route: `DELETE /api/webhooks/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete Webhook
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|