Webhooks: bald verfügbar

Webhooks ermöglichen es CaptainDNS, Ereignisse in Echtzeit an Ihre Systeme zu senden, ohne dass Sie die API per Polling abfragen müssen. Sie befinden sich für die V2 der Public API in Entwicklung und sind noch nicht in Produktion verfügbar. Diese Seite erklärt den Plan und die derzeitigen Alternativen.

Status

• V1 (aktuell): Webhooks nicht verfügbar. Die Tabelle webhook_endpoints existiert in der Datenbank, aber kein Admin-Endpunkt und kein Backend-Emitter verwendet sie.
• V2 (geplant): Event-Emission, HMAC-Signatur, Retry mit exponentiellem Backoff und ein Delivery-Monitoring-Dashboard.

Für die V2 wurde noch kein festes Datum angekündigt. Fortschritte werden im Changelog und im CaptainDNS-Blog bekannt gegeben.

Geplante Anwendungsfälle

Folgende Ereignisse sind für die V2 im Gespräch:

• api_key.rotated: ein Schlüssel wurde rotiert, der alte tritt in die Grace Period ein. Praktisch, um Ihren Secrets-Manager automatisch zu aktualisieren.
• api_key.revoked: ein Schlüssel wurde widerrufen. Praktisch, um eine kompromittierte Integration sofort stillzulegen.
• api_key.expires_soon: ein Schlüssel nähert sich seinem Ablaufdatum (typisch 30 Tage vorher).
• usage.threshold_reached: der Credit-Verbrauch überschreitet einen Schwellenwert (80 %, 100 %, 120 %).
• usage.overage_reported: die monatliche Overage wurde erfolgreich abgerechnet.
• monitoring.alert: eine Anomalie wird auf einem Schlüssel erkannt (Spike zehnmal über dem Schnitt, 429-Storm usw.).

Diese Ereignisse sind Vorschläge; die endgültige Liste wird nach Feedback der V1-Nutzer festgelegt.

Temporäre Alternativen

Solange die V2 nicht verfügbar ist, verwenden Sie eines der folgenden Muster:

Gezieltes Usage-Polling

Der Endpunkt liefert den aktuellen Monat und die 12 vorherigen Monate. Ein täglicher Cron reicht, um Alerts auf Verbrauchsschwellen auszulösen.

if response.credits_used_current / response.credits_limit > 0.8:
    send_slack_alert("API credits usage at 80%")

Clientseitiges Monitoring

Überwachen Sie in Ihrem Client die Header X-Credits-Remaining und X-RateLimit-Remaining. Unterschreiten sie einen kritischen Schwellenwert, lösen Sie einen eigenen Alert aus.

Canary mit Scheduler

Richten Sie einen geplanten Job ein, der einen günstigen Endpunkt aufruft (z. B. POST /public/v1/resolve auf einer Canary-Domain) und Status sowie Header protokolliert. Eine Serie unerwarteter 401/403 weist auf ein Problem hin.

Was die V2 bringen wird

Mit den Webhooks können Sie:

• Einen HTTPS-Endpunkt im Dashboard /account/webhooks registrieren.
• Ereignisse per Checkbox auswählen.
• Ein gemeinsames Secret für die HMAC-Signatur jeder Lieferung definieren.
• Ein Dashboard mit erfolgreichen, fehlgeschlagenen und wartenden Lieferungen einsehen.
• Eine gescheiterte Lieferung manuell wiederholen.

Der Starter-Plan soll 3 Endpunkte enthalten, Pro 10, Business und Enterprise unbegrenzt (im Rahmen der Fair-Use-Policy).

Benachrichtigungen abonnieren

So bleiben Sie informiert:

• Abonnieren Sie den CaptainDNS-Blog: Feature-Launches werden in dedizierten Beiträgen angekündigt.
• Verfolgen Sie das Changelog der Public API, bei jedem Release aktualisiert.
• Enterprise-Kunden mit Account Manager erhalten eine Vorankündigung per E-Mail, mit Zugang zur Beta.

In der Zwischenzeit sind der Schnellstart und die OpenAPI-Referenz die beste Möglichkeit zur Integration.