Webhook-Ziel aktualisieren API

curl

curl -X PATCH 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "subscribed_events": [
      "status.updated",
      "data.updated",
      "transaction.created"
    ]
  }'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.webhooks.destinations.update("11111111-2222-3333-4444-555555555555", {
  enabled: false,
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Webhooks.Destinations.Update(ctx, "11111111-2222-3333-4444-555555555555", didit.WebhooksDestinationsUpdateParams{
	Enabled: didit.Bool(false),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.WebhooksDestinationsUpdateParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.webhooks().destinations().update("11111111-2222-3333-4444-555555555555", WebhooksDestinationsUpdateParams.builder()
        .enabled(false)
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->webhooks->destinations->update('11111111-2222-3333-4444-555555555555', [
    'enabled' => false,
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Webhooks.Destinations.UpdateAsync("11111111-2222-3333-4444-555555555555", new WebhooksDestinationsUpdateParams
{
    Enabled = false,
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "uuid": "11111111-2222-3333-4444-555555555555",
  "label": "Production session webhooks",
  "url": "https://yourapp.com/webhooks/didit",
  "enabled": false,
  "webhook_version": "v3",
  "secret_shared_key": "tno2NTeRC1ZK3sBOYlBJDyEzBVENl3pQ1AcZyAW0xnQ",
  "secret_last4": "0xnQ",
  "previous_secret_expires_at": null,
  "subscribed_events": [
    "status.updated",
    "data.updated"
  ],
  "created_by_email": null,
  "created_by_name": null,
  "created_at": "2026-01-04T08:00:00Z",
  "updated_at": "2026-05-17T11:02:55Z",
  "health_status": "healthy",
  "failing_streak": 0,
  "failing_since": null,
  "last_success_at": "2026-05-17T09:21:18Z",
  "environment": "live",
  "summary": {
    "total_deliveries": 12453,
    "failed_deliveries": 14,
    "error_rate_percentage": 0,
    "min_response_time_ms": 41,
    "avg_response_time_ms": 187,
    "max_response_time_ms": 2103,
    "last_delivery_at": "2026-05-17T09:21:18Z",
    "metrics_window_days": 30
  }
}

PATCH

webhook

destinations

{destination_uuid}

curl

curl -X PATCH 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "subscribed_events": [
      "status.updated",
      "data.updated",
      "transaction.created"
    ]
  }'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.webhooks.destinations.update("11111111-2222-3333-4444-555555555555", {
  enabled: false,
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Webhooks.Destinations.Update(ctx, "11111111-2222-3333-4444-555555555555", didit.WebhooksDestinationsUpdateParams{
	Enabled: didit.Bool(false),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.WebhooksDestinationsUpdateParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.webhooks().destinations().update("11111111-2222-3333-4444-555555555555", WebhooksDestinationsUpdateParams.builder()
        .enabled(false)
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->webhooks->destinations->update('11111111-2222-3333-4444-555555555555', [
    'enabled' => false,
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Webhooks.Destinations.UpdateAsync("11111111-2222-3333-4444-555555555555", new WebhooksDestinationsUpdateParams
{
    Enabled = false,
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "uuid": "11111111-2222-3333-4444-555555555555",
  "label": "Production session webhooks",
  "url": "https://yourapp.com/webhooks/didit",
  "enabled": false,
  "webhook_version": "v3",
  "secret_shared_key": "tno2NTeRC1ZK3sBOYlBJDyEzBVENl3pQ1AcZyAW0xnQ",
  "secret_last4": "0xnQ",
  "previous_secret_expires_at": null,
  "subscribed_events": [
    "status.updated",
    "data.updated"
  ],
  "created_by_email": null,
  "created_by_name": null,
  "created_at": "2026-01-04T08:00:00Z",
  "updated_at": "2026-05-17T11:02:55Z",
  "health_status": "healthy",
  "failing_streak": 0,
  "failing_since": null,
  "last_success_at": "2026-05-17T09:21:18Z",
  "environment": "live",
  "summary": {
    "total_deliveries": 12453,
    "failed_deliveries": 14,
    "error_rate_percentage": 0,
    "min_response_time_ms": 41,
    "avg_response_time_ms": 187,
    "max_response_time_ms": 2103,
    "last_delivery_at": "2026-05-17T09:21:18Z",
    "metrics_window_days": 30
  }
}

Verwenden Sie diesen Endpoint, um zu ändern, wohin ein Ziel Webhooks sendet, und welche Ereignisse es empfängt.

Aktualisieren von `subscribed_events`

Wenn Sie subscribed_events senden, geben Sie die vollständige Ereignisliste an, die nach der Aktualisierung abonniert bleiben soll. Das Array ersetzt die bisherige Liste abonnierter Ereignisse.

{
  "subscribed_events": [
    "status.updated",
    "data.updated",
    "transaction.created",
    "transaction.status.updated"
  ]
}

Unterstützte Werte sind:

Ereignis	Bedeutung
`status.updated`	Der Status einer Sitzung für Benutzerverifizierung (KYC) oder Unternehmensverifizierung (KYB) hat sich geändert.
`data.updated`	Die Verifizierungsdaten einer Sitzung wurden nach ihrer Erstellung geändert.
`user.status.updated`	Der Status der Benutzerentität hat sich geändert.
`user.data.updated`	Die Daten der Benutzerentität wurden geändert.
`business.status.updated`	Der Status der Unternehmensentität hat sich geändert.
`business.data.updated`	Die Daten der Unternehmensentität wurden geändert.
`activity.created`	Wird akzeptiert, derzeit aber nicht für Live-Traffic zugestellt.
`transaction.created`	Transaktion erstellt und zunächst bewertet.
`transaction.status.updated`	Der Status einer Transaktion hat sich geändert.
`travel_rule.status.updated`	Ein Travel-Rule-Austausch hat seinen Status geändert.
`workflow.compliance_changed`	Der Compliance-Status eines veröffentlichten Workflows hat sich geändert.
`transaction_rule_suggestions.created`	Ein Lauf mit Regelvorschlägen hat neue Regeländerungen vorgeschlagen.

Die Ereignisfamilien Investigator (investigator.*) und Authentication (auth.*) werden ebenfalls akzeptiert. Die vollständige Liste finden Sie unter Webhooks. Detaillierte Ereignisbeschreibungen und übliche Abonnementgruppen finden Sie im Leitfaden zum Erstellen eines Ziels.

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.

Pfadparameter

destination_uuid

string<uuid>

erforderlich

UUID des zu aktualisierenden Ziels.

Body

application/json

label

string

Neuer menschenlesbarer Name.

url

string<uri>

Neue Ziel-URL. Muss innerhalb der Anwendung eindeutig sein.

enabled

boolean

Auf false setzen, um Zustellungen an dieses Ziel zu pausieren, ohne es zu löschen.

webhook_version

enum<string>

Neue Payload-Schemaversion für zukünftige Zustellungen.

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:

["status.updated", "data.updated"]

Antwort

Aktualisiertes Webhook-Ziel. Der Antworttext hat das gleiche Format wie GET /v3/webhook/destinations/{destination_uuid}/.

uuid

string<uuid>

label

string

url

string<uri>

enabled

boolean

webhook_version

enum<string>

Verfügbare Optionen:

v1,

v2,

v3

secret_shared_key

string

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.

previous_secret_expires_at

string<date-time> | null

Wird für 24 Stunden gesetzt, nachdem das Signiergeheimnis des Ziels in der Business Console rotiert wurde. Bis zu diesem Zeitpunkt enthält jede Zustellung an das Ziel auch X-Signature-Previous, X-Signature-V2-Previous und X-Signature-Simple-Previous, erstellt mit dem ersetzten Geheimnis (siehe Signaturprüfung). null, wenn in den letzten 24 Stunden keine Rotation stattgefunden hat.

subscribed_events

enum<string>[]

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:

["status.updated", "data.updated"]

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>

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

summary

object

Zustellungsmetriken für die letzten metrics_window_days (30) Tage. last_delivery_at ist der letzte Versuch, unabhängig davon, wann er unternommen wurde.

Show child attributes

Zuletzt geändert am 7. November 2026

​Aktualisieren von subscribed_events

Autorisierungen

Pfadparameter

Body

Antwort

Aktualisieren von `subscribed_events`