Webhooks
Delete a webhook endpoint
https://ecdsa.com/api/v1/webhooks/deleteDeletes a webhook endpoint of the API key's account together with its delivery history; deliveries that were still waiting for a retry are dropped. An id that is not one of the account's endpoints is answered with webhook_not_found.
- API-Schlüssel
- Erforderlich, mit dem Scope webhooks
- Kontingentverbrauch mit Schlüssel
- 1 Einheit pro Aufruf
- Rate Limit
- 60 Anfragen/min pro IP
Anfrage
JSON-Body: DeleteWebhookRequest
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| id | string | ja | The endpoint's id (listWebhooks lists them). |
Antworten
200The endpoint is gone.
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| id | string | ja |
|
| deleted | boolean | ja |
|
Header: X-Request-Id · X-RateLimit-Limit · X-RateLimit-Remaining · X-RateLimit-Reset · X-Quota-Limit · X-Quota-Remaining · X-Quota-Reset
| Status | Bedeutung | Codes |
|---|---|---|
| 400 | Bad request. Input limits: a request body of at most 100 KB (a larger one is answered with 413) and arrays and objects nested at most 64 levels deep, JSON documents inside string fields included. | |
| 401 | Unauthorized. | |
| 403 | Forbidden. | |
| 404 | Not found. | |
| 405 | Method not allowed. | |
| 413 | Payload too large. | |
| 429 | Too many requests. | |
| 500 | Internal server error. | |
| 503 | Service unavailable. | |
| 504 | Gateway timeout. |
Jede Fehlerantwort enthält das JSON-Fehlerobjekt; die Fehlertabelle erklärt, was jeder Code bedeutet und was zu tun ist.
Beispiel
Delete an endpoint
curl -sS 'https://ecdsa.com/api/v1/webhooks/delete' \
-H "authorization: Bearer $ECDSA_API_KEY" \
-H 'content-type: application/json' \
-d '{
"id": "7349e17c-8b41-4fc1-b1a9-dca88578ca1c"
}'const response = await fetch("https://ecdsa.com/api/v1/webhooks/delete", {
method: "POST",
headers: { "content-type": "application/json", authorization: `Bearer ${process.env.ECDSA_API_KEY}` },
body: JSON.stringify({
"id": "7349e17c-8b41-4fc1-b1a9-dca88578ca1c"
}),
});
console.log(response.status, await response.json());import os
import httpx
response = httpx.post(
"https://ecdsa.com/api/v1/webhooks/delete",
headers={"authorization": f"Bearer {os.environ['ECDSA_API_KEY']}"},
json={
"id": "7349e17c-8b41-4fc1-b1a9-dca88578ca1c",
},
timeout=30.0,
)
print(response.status_code, response.json()){
"id": "7349e17c-8b41-4fc1-b1a9-dca88578ca1c",
"deleted": true
}Die Antwort der API auf dieses Beispiel, erzeugt für diese Seite am 20. Oktober 2026; relative Zeitangaben und Tageszahlen darin beziehen sich auf diesen Tag.
Fehlercodes
| Code | Status | Bedeutung |
|---|---|---|
| invalid_json | 400 | The body is not valid JSON or not a JSON object; or the input nests arrays and objects more than 64 levels deep (JSON documents inside string fields count too), or is too complex to inspect for private keys. |
| missing_field | 400 | A required field is absent or empty. |
| private_key_rejected | 400 | The request contains private-key material (a PEM PRIVATE KEY block, an OpenSSH, SSH2 or PuTTY private key, or a JWK with "d"). Never send private keys anywhere. |
| unauthorized | 401 | The Authorization or X-API-Key header is malformed, the API key is not valid (wrong checksum, unknown, revoked or expired), or the operation needs a key. |
| forbidden_scope | 403 | The API key is valid but lacks a scope this operation requires; the message names it. |
| not_found | 404 | No operation exists at this path. |
| webhook_not_found | 404 | The API key's account has no webhook endpoint with this id. |
| method_not_allowed | 405 | The path exists but does not accept this HTTP method; see the Allow header. |
| payload_too_large | 413 | The body exceeds 100 KB. |
| rate_limited | 429 | Too many requests — see Retry-After. |
| quota_exceeded | 429 | A daily or monthly quota of the API key's account is used up. X-Quota-Reset (and Retry-After) say when it starts over; retrying earlier cannot succeed. |
| internal_error | 500 | Unexpected server error. |
| service_unavailable | 503 | API keys cannot be verified right now (the key store is unreachable); retry shortly. |
| webhooks_unavailable | 503 | Webhooks are switched off on this server: it has no signing keys configured. |
| timeout | 504 | The operation did not finish within its time budget. |
Schemas
Error
The error envelope of every non-2xx response.
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| error | object | ja | |
| error.code | string | ja | Machine-readable error code. Each response lists the codes it can carry; new codes may be added within v1, so treat an unknown code by its HTTP status. |
| error.message | string | ja | Human-readable explanation (English). |
| error.requestId | string | nein | The X-Request-Id of this request — quote it when reporting a problem. Sent since v1.1. |
| error.detail | object | nein | Structured context for the error, such as the offending field; omitted when there is none.
|
| error.docs | string | nein | Where the error codes are explained. Sent since v1.1.
|
Alle Operationen findest du in der API-Referenz.