Zum Inhalt springen
ecdsa.com

Webhooks

List webhook endpoints

GEThttps://ecdsa.com/api/v1/webhooks

The webhook endpoints of the API key's account, oldest first, each with its most recent delivery, and the number of endpoints the account's plan allows. Deliveries are POST requests with a JSON body, signed with ECDSA P-256 (ES256): headers ECDSA-Webhook-Id, ECDSA-Webhook-Timestamp and ECDSA-Signature (t=<unix seconds>,kid=<key id>,es256=<base64url r‖s>) over the UTF-8 bytes of "<id>.<t>.<raw body>". The public keys are the JWKS at https://ecdsa.com/.well-known/ecdsa-webhook-keys.json; every official SDK verifies deliveries with verifyWebhook().

API-Schlüssel
Erforderlich, mit dem Scope webhooks
Kontingentverbrauch mit Schlüssel
1 Einheit pro Aufruf
Rate Limit
60 Anfragen/min pro IP

Anfrage

Diese Operation erwartet keine Eingabe.

Antworten

200The account's webhook endpoints.

FeldTypErforderlichBeschreibung
endpointsWebhookEndpoint[]ja
limitintegerja

How many endpoints the account's plan allows.

  • mindestens 0
keysstringja

The JWKS with the public keys deliveries are signed with.

  • Format uri

Header: X-Request-Id · X-RateLimit-Limit · X-RateLimit-Remaining · X-RateLimit-Reset · X-Quota-Limit · X-Quota-Remaining · X-Quota-Reset

StatusBedeutungCodes
401Unauthorized.
403Forbidden.
404Not found.
405Method not allowed.
429Too many requests.
500Internal server error.
503Service unavailable.
504Gateway timeout.

Jede Fehlerantwort enthält das JSON-Fehlerobjekt; die Fehlertabelle erklärt, was jeder Code bedeutet und was zu tun ist.

Beispiel

The account's endpoints

curl
curl -sS 'https://ecdsa.com/api/v1/webhooks' \
  -H "authorization: Bearer $ECDSA_API_KEY"
JavaScript (fetch)
const response = await fetch("https://ecdsa.com/api/v1/webhooks", {
  headers: { authorization: `Bearer ${process.env.ECDSA_API_KEY}` },
});
console.log(response.status, await response.json());
Python (httpx)
import os

import httpx

response = httpx.get(
    "https://ecdsa.com/api/v1/webhooks",
    headers={"authorization": f"Bearer {os.environ['ECDSA_API_KEY']}"},
    timeout=30.0,
)
print(response.status_code, response.json())
Antwort 200
{
  "endpoints": [
    {
      "id": "7349e17c-8b41-4fc1-b1a9-dca88578ca1c",
      "url": "https://hooks.example.com/ecdsa",
      "description": "Production alerts",
      "events": [
        "monitor.*"
      ],
      "enabled": true,
      "createdAt": "2026-10-20T07:34:27.000Z",
      "disabledAt": null,
      "disabledReason": null,
      "lastDelivery": {
        "id": "d651f9e5-2002-4bde-a6d0-e7439333a4bd",
        "type": "webhook.test",
        "status": "delivered",
        "attempts": 1,
        "createdAt": "2026-10-20T07:34:27.000Z",
        "lastAttemptAt": "2026-10-20T07:34:27.000Z",
        "lastStatusCode": 204,
        "lastError": null,
        "nextAttemptAt": null,
        "deliveredAt": "2026-10-20T07:34:27.000Z"
      }
    }
  ],
  "limit": 1,
  "keys": "https://ecdsa.com/.well-known/ecdsa-webhook-keys.json"
}

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

CodeStatusBedeutung
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.
method_not_allowed405The path exists but does not accept this HTTP method; see the Allow header.
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.

Schemas

WebhookEndpoint

FeldTypErforderlichBeschreibung
idstringja
  • Format uuid
  • Muster ^([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)$
urlstringja
descriptionstring | nullja
eventsstring[]ja

Subscribed event types or families ("monitor.*"); empty receives every event.

enabledbooleanja
createdAtstringja

UTC time, ISO 8601.

  • Format date-time
disabledAtstring | nullja
disabledReasonstring | nullja

Why deliveries stopped: "consecutive_failures" after five failed deliveries in a row.

lastDeliveryWebhookDelivery | nullja

WebhookDelivery

FeldTypErforderlichBeschreibung
idstringja

Delivery id, sent as ECDSA-Webhook-Id and as the body's id; the same on every retry.

typestringja

Event type, e.g. "monitor.grade_changed" or "webhook.test".

statusstringja
  • einer der Werte "pending", "delivered" oder "failed"
attemptsintegerja
  • mindestens 0
createdAtstringja

UTC time, ISO 8601.

  • Format date-time
lastAttemptAtstring | nullja
lastStatusCodeinteger | nullja

HTTP status of the last attempt; null when no response arrived.

lastErrorstring | nullja

Why the last attempt failed: "http_status" (any status outside 200–299, redirects included), "timeout", "address_refused", "tls_certificate", "endpoint_disabled", … ; null after a success.

nextAttemptAtstring | nullja

When a pending delivery is tried again.

deliveredAtstring | nullja

Error

The error envelope of every non-2xx response.

FeldTypErforderlichBeschreibung
errorobjectja
error.codestringja

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

Human-readable explanation (English).

error.requestIdstringnein

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

error.detailobjectnein

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

  • beliebige Feldnamen
error.docsstringnein

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

  • Format uri

Alle Operationen findest du in der API-Referenz.