Zum Hauptinhalt springen
GET
curl

​
Status des Ziels

health_status fasst zusammen, wie ein Ziel auf seine Zustellungen reagiert hat. Ein fehlgeschlagener Versuch liegt vor, wenn das Ziel mit HTTP 400 oder höher geantwortet hat oder gar nicht geantwortet hat (Timeout, abgelehnte Verbindung oder blockierte Adresse). Wiederholungsversuche erhöhen failing_streak nicht. Jeder erfolgreiche Versuch, auch ein Wiederholungsversuch oder ein erneutes Senden, beendet die Serie. health_status ist unabhängig von enabled. Die Zustellungsmetriken und daily_points decken die letzten 30 Tage ab (metrics_window_days). daily_points enthält immer 30 Einträge, einen pro UTC-Tag, beginnend mit dem ältesten.

​
Verwandte Themen

Autorisierungen

​
x-api-key
string
header
erforderlich

Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.

Antwort

Liste der Webhook-Ziele (nicht paginiert, älteste zuerst).

​
uuid
string<uuid>

Stabiler Ziel-Identifikator; als {destination_uuid} für Aktualisierung/Löschung verwenden.

​
label
string

Lesbarer Name, der in der Console angezeigt wird.

​
url
string<uri>

Ziel-URL, die POST-Anfragen mit der Webhook-Payload empfängt.

​
enabled
boolean

Wenn false, überspringt Didit die Zustellung an dieses Ziel stillschweigend.

​
webhook_version
enum<string>

Payload-Schema-Version, die an dieses Ziel gesendet wird. v3 ist das aktuelle/empfohlene Format.

Verfügbare Optionen:
v1,
v2,
v3
​
subscribed_events
enum<string>[]

Ereignisfilter für dieses Webhook-Ziel. Didit stellt nur Webhooks zu, deren Ereignistyp exakt mit einem dieser Werte übereinstimmt – es gibt kein Wildcard-Abonnement. Beim Senden muss die Liste mindestens ein gültiges Ereignis enthalten (ein explizites [] wird mit 400 abgelehnt); ein Ziel mit leerer Liste (Feld bei der Erstellung weggelassen) empfängt nichts. Bei einer Aktualisierung wird die Liste vollständig ersetzt, niemals zusammengeführt.

Minimum array length: 1

Name des unterstützten Webhook-Ereignisses. Verwenden Sie genau diese Zeichenfolgen in subscribed_events; nicht unterstützte Werte werden abgelehnt.

Verfügbare Optionen:
status.updated,
data.updated,
user.status.updated,
user.data.updated,
business.status.updated,
business.data.updated,
activity.created,
transaction.created,
transaction.status.updated,
travel_rule.status.updated,
workflow.compliance_changed,
transaction_rule_suggestions.created,
auth.signup,
auth.login,
auth.login_failed,
auth.password_reset_requested,
auth.password_reset_completed,
auth.mfa_changed,
auth.new_device,
auth.account_locked,
investigator.report.ready,
investigator.decision.automated,
investigator.decision.overridden,
investigator.decision.contested,
investigator.question.raised,
investigator.automation.paused,
investigator.rfi.answered,
investigator.rfi.overdue,
investigator.drift.detected,
investigator.sla.breached,
investigator.qa.failed,
investigator.external.report.ready
Beispiel:
​
subscribed_events_count
integer

Gecachte Länge von subscribed_events, nützlich für das Rendern der Benutzeroberfläche.

​
deliveries_count
integer

Zustellungsversuche (einschließlich Wiederholungsversuche), die in den letzten 30 Tagen an dieses Ziel gesendet wurden.

​
failed_deliveries_count
integer

Zustellungsversuche in den letzten 30 Tagen, die das Ziel mit HTTP 400 oder höher beantwortet hat oder die unbeantwortet blieben (Timeout, abgelehnte Verbindung oder blockierte Adresse).

​
average_response_time_ms
integer | null

Durchschnittliche Antwortzeit in Millisekunden über die letzten 30 Tage, gerundet auf eine Ganzzahl. null, wenn in diesem Zeitraum keine Zustellungen stattfanden.

​
error_rate_percentage
integer

round(failed_deliveries_count / deliveries_count * 100) über die letzten 30 Tage; 0, wenn keine Zustellungen vorliegen.

​
last_delivery_at
string<date-time> | null

Zeitstempel des letzten Zustellungsversuchs (Erfolg oder Fehlschlag). null, falls nie zugestellt.

​
metrics_window_days
integer

Länge des Zeitfensters in Tagen, das von deliveries_count, failed_deliveries_count, average_response_time_ms, error_rate_percentage und daily_points abgedeckt wird. Immer 30.

​
health_status
enum<string>

Zustellungsstatus. failing: Bei 3 oder mehr aufeinanderfolgenden Ereignissen ist jeweils der erste Zustellversuch fehlgeschlagen, seit das Ziel zuletzt erfolgreich geantwortet hat (siehe failing_streak). degraded: nicht failing, aber in den letzten 24 Stunden ist ein Zustellversuch fehlgeschlagen und kein späterer Versuch hat dieses Ereignis zugestellt; ein Wiederholungsversuch oder ein erneutes Senden, das es zustellt, hebt dies auf. healthy: weder noch. Unabhängig von enabled. Ein fehlgeschlagener Versuch ist ein Versuch, der mit HTTP 400 oder höher beantwortet oder überhaupt nicht beantwortet wurde.

Verfügbare Optionen:
healthy,
degraded,
failing
​
failing_streak
integer

Wie viele aufeinanderfolgende Ereignisse bei ihrem ersten Zustellversuch fehlgeschlagen sind, seit das Ziel innerhalb der letzten 30 Tage zuletzt erfolgreich geantwortet hat. Wiederholungsversuche werden nicht gezählt, und jeder erfolgreiche Versuch, einschließlich eines Wiederholungsversuchs oder eines erneuten Sendens, beendet die Serie. 0, wenn seit dem letzten Erfolg kein Ereignis fehlgeschlagen ist.

​
failing_since
string<date-time> | null

Wann der erste fehlgeschlagene Versuch der aktuellen failing_streak unternommen wurde. null, wenn failing_streak den Wert 0 hat.

​
last_success_at
string<date-time> | null

Wann das Ziel zuletzt innerhalb der letzten 30 Tage auf eine Zustellung mit einem HTTP-Status unter 400 geantwortet hat. null, wenn dies in diesem Zeitfenster nicht der Fall war.

​
environment
enum<string>

Umgebung der Anwendung, zu der das Ziel gehört.

Verfügbare Optionen:
live,
sandbox
​
daily_points
object[]

Ein Eintrag pro UTC-Tag der letzten 30 Tage, älteste zuerst, einschließlich Tagen ohne Zustellungen. Zählt jeden Versuch, einschließlich Wiederholungsversuchen.

​
secret_last4
string

Die letzten vier Zeichen des aktuellen Signiergeheimnisses des Ziels, damit Sie Geheimnisse voneinander unterscheiden können. Reicht nicht aus, um eine Signatur zu verifizieren.

​
created_by_email
string | null

E-Mail des Mitglieds der Business Console, das das Ziel erstellt hat. null für ein mit einem API-Schlüssel erstelltes Ziel.

​
created_by_name
string | null

Name des Mitglieds der Business Console, das das Ziel erstellt hat. null bei einem Ziel, das mit einem API-Schlüssel erstellt wurde.

​
created_at
string<date-time>
​
updated_at
string<date-time>
Zuletzt geändert am 7. November 2026