85 lines
2.1 KiB
Markdown
85 lines
2.1 KiB
Markdown
---
|
|
name: event-hooks-routes
|
|
description: Handle 8 OpenAPI operation(s) under /api/v1/eventHooks for the eventHooks route group.
|
|
---
|
|
|
|
# eventHooks API Routes
|
|
|
|
Handle 8 OpenAPI operation(s) under /api/v1/eventHooks for the eventHooks 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
|
|
|
|
### list_event_hooks
|
|
|
|
- Operation ID: `list_event_hooks`
|
|
- Route: `GET /api/v1/eventHooks`
|
|
- Mode: READ
|
|
- Summary: List all event hooks
|
|
|
|
### create_event_hook
|
|
|
|
- Operation ID: `create_event_hook`
|
|
- Route: `POST /api/v1/eventHooks`
|
|
- Mode: WRITE
|
|
- Summary: Create an event hook
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_event_hook
|
|
|
|
- Operation ID: `get_event_hook`
|
|
- Route: `GET /api/v1/eventHooks/{eventHookId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve an event hook
|
|
- Parameters:
|
|
- `eventHookId` in `path` required
|
|
|
|
### replace_event_hook
|
|
|
|
- Operation ID: `replace_event_hook`
|
|
- Route: `PUT /api/v1/eventHooks/{eventHookId}`
|
|
- Mode: WRITE
|
|
- Summary: Replace an event hook
|
|
- Parameters:
|
|
- `eventHookId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_event_hook
|
|
|
|
- Operation ID: `delete_event_hook`
|
|
- Route: `DELETE /api/v1/eventHooks/{eventHookId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete an event hook
|
|
- Parameters:
|
|
- `eventHookId` in `path` required
|
|
|
|
### activate_event_hook
|
|
|
|
- Operation ID: `activate_event_hook`
|
|
- Route: `POST /api/v1/eventHooks/{eventHookId}/lifecycle/activate`
|
|
- Mode: WRITE
|
|
- Summary: Activate an event hook
|
|
- Parameters:
|
|
- `eventHookId` in `path` required
|
|
|
|
### deactivate_event_hook
|
|
|
|
- Operation ID: `deactivate_event_hook`
|
|
- Route: `POST /api/v1/eventHooks/{eventHookId}/lifecycle/deactivate`
|
|
- Mode: WRITE
|
|
- Summary: Deactivate an event hook
|
|
- Parameters:
|
|
- `eventHookId` in `path` required
|
|
|
|
### verify_event_hook
|
|
|
|
- Operation ID: `verify_event_hook`
|
|
- Route: `POST /api/v1/eventHooks/{eventHookId}/lifecycle/verify`
|
|
- Mode: WRITE
|
|
- Summary: Verify an event hook
|
|
- Parameters:
|
|
- `eventHookId` in `path` required
|