80 lines
1.8 KiB
Markdown
80 lines
1.8 KiB
Markdown
---
|
|
name: webhooks-routes
|
|
description: Handle 7 OpenAPI operation(s) under /v2/webhooks for the webhooks route group.
|
|
---
|
|
|
|
# webhooks API Routes
|
|
|
|
Handle 7 OpenAPI operation(s) under /v2/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
|
|
|
|
### webhooks_get
|
|
|
|
- Operation ID: `webhooks_get`
|
|
- Route: `GET /v2/webhooks`
|
|
- Mode: READ
|
|
- Summary: Get list of webhooks
|
|
- Parameters:
|
|
- `offset` in `query`
|
|
- `limit` in `query`
|
|
- `desc` in `query`
|
|
|
|
### webhooks_post
|
|
|
|
- Operation ID: `webhooks_post`
|
|
- Route: `POST /v2/webhooks`
|
|
- Mode: WRITE
|
|
- Summary: Create webhook
|
|
- Body: JSON request body accepted.
|
|
|
|
### webhook_get
|
|
|
|
- Operation ID: `webhook_get`
|
|
- Route: `GET /v2/webhooks/{webhookId}`
|
|
- Mode: READ
|
|
- Summary: Get webhook
|
|
- Parameters:
|
|
- `webhookId` in `path` required
|
|
|
|
### webhook_put
|
|
|
|
- Operation ID: `webhook_put`
|
|
- Route: `PUT /v2/webhooks/{webhookId}`
|
|
- Mode: WRITE
|
|
- Summary: Update webhook
|
|
- Parameters:
|
|
- `webhookId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### webhook_delete
|
|
|
|
- Operation ID: `webhook_delete`
|
|
- Route: `DELETE /v2/webhooks/{webhookId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete webhook
|
|
- Parameters:
|
|
- `webhookId` in `path` required
|
|
|
|
### webhook_test_post
|
|
|
|
- Operation ID: `webhook_test_post`
|
|
- Route: `POST /v2/webhooks/{webhookId}/test`
|
|
- Mode: WRITE
|
|
- Summary: Test webhook
|
|
- Parameters:
|
|
- `webhookId` in `path` required
|
|
|
|
### webhook_webhook_dispatches_get
|
|
|
|
- Operation ID: `webhook_webhook_dispatches_get`
|
|
- Route: `GET /v2/webhooks/{webhookId}/dispatches`
|
|
- Mode: READ
|
|
- Summary: Get collection
|
|
- Parameters:
|
|
- `webhookId` in `path` required
|