Delete webhook
Interface Description
Delete one webhook subscription by webhookId.
Endpoint
| Field | Value |
|---|---|
| Method | DELETE |
| Path | /openapi/v2/webhooks/{webhookId} |
| Operation ID | deleteWebhook |
| Authentication | Bearer OpenAPI key |
Parameters
| Name | Location | Required | Type | Example | Description |
|---|---|---|---|---|---|
webhookId | path | Yes | string | webhook-11111111-1111-4111-8111-111111111111 | Webhook identifier returned by webhook APIs. |
Request Body
This operation has no request body.
Request Example
bash
curl -X DELETE "https://openapi.example.com/openapi/v2/webhooks/webhook-11111111-1111-4111-8111-111111111111" \
-H "Authorization: Bearer <openapi-key>"Successful Responses
200
Confirmation that the webhook subscription was deleted.
| Field | Required | Type | Description |
|---|---|---|---|
deleted | Yes | boolean | Whether the webhook subscription was deleted. |
webhookId | Yes | string | Deleted webhook identifier. |
Success Response Example
json
{
"deleted": true,
"webhookId": "webhook-11111111-1111-4111-8111-111111111111"
}Error Codes
The table below lists every error response documented for this operation.
| HTTP Status | Error Code | Explanation |
|---|---|---|
| 401 | UNAUTHORIZED | The Bearer API key is missing, malformed, unknown, revoked, or deleted. |
| 404 | NOT_FOUND | The requested resource was not found. |
| 429 | RATE_LIMITED | The request exceeded the configured rate limits. |
| 500 | INTERNAL_ERROR | The API encountered an internal error. |
| 503 | DATABASE_REPOSITORY_UNAVAILABLE | The data required by this operation is temporarily unavailable. |