Aller au contenu
ecdsa.com

Webhooks

Delete a webhook endpoint

POSThttps://ecdsa.com/api/v1/webhooks/delete

Deletes 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.

Clé d’API
Obligatoire, avec le scope webhooks
Coût en quota avec une clé
1 unité par appel
Limite de requêtes
60 requêtes/min par IP

Requête

Corps JSON : DeleteWebhookRequest

ChampTypeObligatoireDescription
idstringoui

The endpoint's id (listWebhooks lists them).

Réponses

200The endpoint is gone.

ChampTypeObligatoireDescription
idstringoui
  • format uuid
  • motif ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
deletedbooleanoui
  • toujours true

En-têtes : X-Request-Id · X-RateLimit-Limit · X-RateLimit-Remaining · X-RateLimit-Reset · X-Quota-Limit · X-Quota-Remaining · X-Quota-Reset

StatutSignificationCodes
400Bad 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.
401Unauthorized.
403Forbidden.
404Not found.
405Method not allowed.
413Payload too large.
429Too many requests.
500Internal server error.
503Service unavailable.
504Gateway timeout.

Chaque réponse d’erreur porte l’enveloppe JSON ; le tableau des erreurs indique ce que signifie chaque code et que faire.

Exemple

Delete an endpoint

curl
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"
}'
JavaScript (fetch)
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());
Python (httpx)
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())
Réponse 200
{
  "id": "7349e17c-8b41-4fc1-b1a9-dca88578ca1c",
  "deleted": true
}

La réponse de l’API à cet exemple, générée pour cette page le 20 octobre 2026 ; les temps relatifs et les nombres de jours qu’elle contient se rapportent à ce jour-là.

Codes d’erreur

CodeStatutSignification
invalid_json400The 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_field400A required field is absent or empty.
private_key_rejected400The 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.
unauthorized401The 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_scope403The API key is valid but lacks a scope this operation requires; the message names it.
not_found404No operation exists at this path.
webhook_not_found404The API key's account has no webhook endpoint with this id.
method_not_allowed405The path exists but does not accept this HTTP method; see the Allow header.
payload_too_large413The body exceeds 100 KB.
rate_limited429Too many requests — see Retry-After.
quota_exceeded429A 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_error500Unexpected server error.
service_unavailable503API keys cannot be verified right now (the key store is unreachable); retry shortly.
webhooks_unavailable503Webhooks are switched off on this server: it has no signing keys configured.
timeout504The operation did not finish within its time budget.

Schémas

Error

The error envelope of every non-2xx response.

ChampTypeObligatoireDescription
errorobjectoui
error.codestringoui

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.messagestringoui

Human-readable explanation (English).

error.requestIdstringnon

The X-Request-Id of this request — quote it when reporting a problem. Sent since v1.1.

error.detailobjectnon

Structured context for the error, such as the offending field; omitted when there is none.

  • noms de membres libres
error.docsstringnon

Where the error codes are explained. Sent since v1.1.

  • format uri

Toutes les opérations sont répertoriées dans la référence de l’API.