2.5 KiB
2.5 KiB
name, description
| name | description |
|---|---|
| webhooks-routes | Handle 8 OpenAPI operation(s) under /v2/webhooks for the webhooks route group. |
webhooks API Routes
Handle 8 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
list_webhook_event_types
- Operation ID:
list_webhook_event_types - Route:
GET /v2/webhooks/event-types - Mode: READ
- Summary: ListWebhookEventTypes
- Parameters:
api_versioninquery
list_webhook_subscriptions
- Operation ID:
list_webhook_subscriptions - Route:
GET /v2/webhooks/subscriptions - Mode: READ
- Summary: ListWebhookSubscriptions
- Parameters:
cursorinqueryinclude_disabledinquerysort_orderinquerylimitinquery
create_webhook_subscription
- Operation ID:
create_webhook_subscription - Route:
POST /v2/webhooks/subscriptions - Mode: WRITE
- Summary: CreateWebhookSubscription
- Body: JSON request body accepted.
delete_webhook_subscription
- Operation ID:
delete_webhook_subscription - Route:
DELETE /v2/webhooks/subscriptions/{subscription_id} - Mode: WRITE
- Summary: DeleteWebhookSubscription
- Parameters:
subscription_idinpathrequired
retrieve_webhook_subscription
- Operation ID:
retrieve_webhook_subscription - Route:
GET /v2/webhooks/subscriptions/{subscription_id} - Mode: READ
- Summary: RetrieveWebhookSubscription
- Parameters:
subscription_idinpathrequired
update_webhook_subscription
- Operation ID:
update_webhook_subscription - Route:
PUT /v2/webhooks/subscriptions/{subscription_id} - Mode: WRITE
- Summary: UpdateWebhookSubscription
- Parameters:
subscription_idinpathrequired
- Body: JSON request body accepted.
update_webhook_subscription_signature_key
- Operation ID:
update_webhook_subscription_signature_key - Route:
POST /v2/webhooks/subscriptions/{subscription_id}/signature-key - Mode: WRITE
- Summary: UpdateWebhookSubscriptionSignatureKey
- Parameters:
subscription_idinpathrequired
- Body: JSON request body accepted.
test_webhook_subscription
- Operation ID:
test_webhook_subscription - Route:
POST /v2/webhooks/subscriptions/{subscription_id}/test - Mode: WRITE
- Summary: TestWebhookSubscription
- Parameters:
subscription_idinpathrequired
- Body: JSON request body accepted.