61 lines
1.4 KiB
Markdown
61 lines
1.4 KiB
Markdown
---
|
|
name: webhooks-routes
|
|
description: Handle 5 OpenAPI operation(s) under /webhooks for the webhooks route group.
|
|
---
|
|
|
|
# webhooks API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /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 /webhooks`
|
|
- Mode: READ
|
|
- Summary: List all webhooks
|
|
- Parameters:
|
|
- `marker` in `query`
|
|
- `limit` in `query`
|
|
|
|
### post_webhooks
|
|
|
|
- Operation ID: `post_webhooks`
|
|
- Route: `POST /webhooks`
|
|
- Mode: WRITE
|
|
- Summary: Create webhook
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_webhooks_id
|
|
|
|
- Operation ID: `get_webhooks_id`
|
|
- Route: `GET /webhooks/{webhook_id}`
|
|
- Mode: READ
|
|
- Summary: Get webhook
|
|
- Parameters:
|
|
- `webhook_id` in `path` required
|
|
|
|
### put_webhooks_id
|
|
|
|
- Operation ID: `put_webhooks_id`
|
|
- Route: `PUT /webhooks/{webhook_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update webhook
|
|
- Parameters:
|
|
- `webhook_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_webhooks_id
|
|
|
|
- Operation ID: `delete_webhooks_id`
|
|
- Route: `DELETE /webhooks/{webhook_id}`
|
|
- Mode: WRITE
|
|
- Summary: Remove webhook
|
|
- Parameters:
|
|
- `webhook_id` in `path` required
|