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().

Chave de API: Obrigatória, com o escopo webhooks
Custo em cota com chave: 1 unidade por chamada
Limite de taxa: 60 requisições/min por IP

Requisição

Esta operação não recebe entrada.

Respostas

200The account's webhook endpoints.

Campo	Tipo	Obrigatório	Descrição
endpoints	WebhookEndpoint[]	sim
limit	integer	sim	How many endpoints the account's plan allows. no mínimo 0
keys	string	sim	The JWKS with the public keys deliveries are signed with. formato uri

Campo

Tipo

Obrigatório

Descrição

endpoints

WebhookEndpoint[]

sim

limit

integer

sim

How many endpoints the account's plan allows.

no mínimo 0

keys

string

sim

The JWKS with the public keys deliveries are signed with.

formato uri

Cabeçalhos: X-Request-Id · X-RateLimit-Limit · X-RateLimit-Remaining · X-RateLimit-Reset · X-Quota-Limit · X-Quota-Remaining · X-Quota-Reset

Status	Significado	Códigos
401	Unauthorized.	unauthorized
403	Forbidden.	forbidden_scope
404	Not found.	not_found
405	Method not allowed.	method_not_allowed
429	Too many requests.	rate_limited quota_exceeded
500	Internal server error.	internal_error
503	Service unavailable.	service_unavailable webhooks_unavailable
504	Gateway timeout.	timeout

Toda resposta de erro traz o envelope JSON; a tabela de erros explica o que cada código significa e o que fazer.

Exemplo

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())

Resposta 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"
}

A resposta da API a este exemplo, gerada para esta página em 20 de outubro de 2026; tempos relativos e contagens de dias nela se referem a esse dia.

Códigos de erro

Código	Status	Significado
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.
method_not_allowed	405	The path exists but does not accept this HTTP method; see the Allow header.
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

WebhookEndpoint

Campo	Tipo	Obrigatório	Descrição
id	string	sim	formato uuid expressão regular ^([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)$
url	string	sim
description	string \| null	sim
events	string[]	sim	Subscribed event types or families ("monitor.*"); empty receives every event.
enabled	boolean	sim
createdAt	string	sim	UTC time, ISO 8601. formato date-time
disabledAt	string \| null	sim
disabledReason	string \| null	sim	Why deliveries stopped: "consecutive_failures" after five failed deliveries in a row.
lastDelivery	WebhookDelivery \| null	sim

WebhookDelivery

Campo	Tipo	Obrigatório	Descrição
id	string	sim	Delivery id, sent as ECDSA-Webhook-Id and as the body's id; the same on every retry.
type	string	sim	Event type, e.g. "monitor.grade_changed" or "webhook.test".
status	string	sim	um dos valores "pending", "delivered" ou "failed"
attempts	integer	sim	no mínimo 0
createdAt	string	sim	UTC time, ISO 8601. formato date-time
lastAttemptAt	string \| null	sim
lastStatusCode	integer \| null	sim	HTTP status of the last attempt; null when no response arrived.
lastError	string \| null	sim	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.
nextAttemptAt	string \| null	sim	When a pending delivery is tried again.
deliveredAt	string \| null	sim

Error

The error envelope of every non-2xx response.

Campo	Tipo	Obrigatório	Descrição
error	object	sim
error.code	string	sim	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	sim	Human-readable explanation (English).
error.requestId	string	não	The X-Request-Id of this request — quote it when reporting a problem. Sent since v1.1.
error.detail	object	não	Structured context for the error, such as the offending field; omitted when there is none. quaisquer nomes de membros
error.docs	string	não	Where the error codes are explained. Sent since v1.1. formato uri

Todas as operações estão listadas na referência da API.