> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # Webhook-Konfiguration aktualisieren: Management API > Aktualisieren Sie mit der Didit Management API Webhook, Secret, Datenaufbewahrung und Rückgabe-Hosts der Digital-ID-Wallet. API-Prompt zur Aktualisierung der Webhook-Konfiguration Prompt in die Zwischenablage kopieren \

\`Update my Didit application's webhook configuration through the Management API.

Endpoint:
PATCH https://verification.didit.me/v3/webhook/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs webhooks: write.

Goal:
\- Change application-level settings: the legacy webhook URL and version, the application secret, the data-retention and biometric-template retention policy, the Digital ID wallet return hosts, or the allowed origins of the hosted flow.

Behavior:
\- Partial update: send only the fields to change. The response is the full configuration, the same shape as GET /v3/webhook/.
\- webhook_url and webhook_version change the application-level (legacy) webhook only. Didit uses it only while the application has no enabled destination, and only for status.updated and data.updated. It does not create a destination, and the next create, update or delete of a destination replaces webhook_url. To receive webhooks, create a destination with POST /v3/webhook/destinations/ instead.
\- rotate_secret_key: true replaces the application-level secret_shared_key immediately. Destination secrets are not changed. Each call generates a new secret, so it is not idempotent.
\- data_retention_months (1 to 120, or null for no automatic deletion): user verification sessions older than this many 30-day months are deleted automatically. Business verification sessions are not affected.
\- face_retention_policy (delete_with_session or retain_until_user_deleted) and face_retention_days (1 to 3650). retain_until_user_deleted needs face_retention_days in the same request or already set.
\- allowed_return_hosts replaces the registered list: up to 20 bare hostnames such as app.example.com (no scheme, port, path or wildcard). Send [] to clear it.
\- allowed_domains replaces the list of web origins (for example https://app.example.com; http only for localhost) that the hosted verification flow may be embedded in and may send the user back to with a session callback: up to 50 entries of at most 300 characters. Send [] to remove the restriction. Server-to-server calls are not affected. An invalid entry returns 400 on allowed_domains.
\- Manage destinations with the /v3/webhook/destinations/ endpoints, not here. Never send an endpoints field to this call: it is not part of this contract.

Example call:
curl -X PATCH "https://verification.didit.me/v3/webhook/" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}'

What to read from the response:
\- The updated fields, and secret_shared_key when you rotated it: store the new value before you discard the response.

Failure modes:
\- 400: field errors, each field mapped to a list of messages, for example { "face_retention_days": ["A finite retention duration is required when face retention is enabled."] }. Nothing is changed.
\- 401: { "detail": "This API key has expired." }
\- 403: { "detail": "You do not have permission to perform this action." } or { "detail": "This API key has no write access to webhooks." }
\- 429: more than 300 write requests per minute with this key; wait for Retry-After.

Side effects:
\- Rotating the secret changes how deliveries to the legacy webhook_url are signed from then on, retries included.
\- A data_retention_months change applies to existing sessions too: every session older than the new window is deleted automatically, and that deletion is irreversible.
\- A face_retention_policy change applies to session deletions from then on; it creates or purges no existing biometric template.

For the full integration shape, see /integration/integration-prompt.`

\
Einfügen in > [!NOTE] > > `rotate_secret_key` rotiert nur das Geheimnis auf Anwendungsebene, das Zustellungen an den veralteten `webhook_url` signiert. Jedes [Webhook-Ziel](https://docs.didit.me/de/management-api/webhook/list-destinations.md) signiert mit seinem eigenen `secret_shared_key`, den dieser Aufruf nicht ändert.Die Aufbewahrungsfelder entsprechen der Richtlinie, die Sie unter **Business Console → App Settings → Data retention** festlegen. Lesen Sie [Datenaufbewahrung](https://docs.didit.me/de/console/data-retention.md), bevor Sie diese ändern, insbesondere die [Aufbewahrung biometrischer Templates](https://docs.didit.me/de/console/data-retention.md#aufbewahrung-biometrischer-templates). `allowed_return_hosts` wird unter [Rückgabeziel registrieren](https://docs.didit.me/de/standalone-apis/digital-id-wallets.md#ihr-rückgabeziel-registrieren) beschrieben.`biometric_consent_mode` (`auto`, `always` oder `never`) legt fest, wann der Verifizierungsablauf vor einer Gesichtsaufnahme eine ausdrückliche biometrische Einwilligung anfordert. Siehe [Biometrische Einwilligung](https://docs.didit.me/de/getting-started/biometric-consent.md).Um zuerst die aktuellen Werte abzurufen, rufen Sie [Webhook-Konfiguration abrufen](https://docs.didit.me/de/management-api/webhook/get-config.md) auf. ## OpenAPI ````yaml de/openapi-25.json PATCH /v3/webhook/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API für Ausweisverifizierung. Authentifizierung über den x-api-key-Header. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/webhook/: patch: tags: - Webhook summary: Webhook-Konfiguration aktualisieren description: >- Einstellungen auf Anwendungsebene teilweise aktualisieren: die Legacy-Webhook-URL, -Version und das Secret, die Aufbewahrungsrichtlinie für Daten und biometrische Templates sowie die Return-Hosts der Digital ID Wallet. Senden Sie nur die zu ändernden Felder; die Antwort ist die vollständige Konfiguration im selben Format wie `GET /v3/webhook/`. Webhook-Ziele werden hier nicht verwaltet: Erstellen, aktualisieren und löschen Sie diese über die Endpoints `/v3/webhook/destinations/`, und senden Sie kein `endpoints`-Feld an diesen Endpoint. Eine Änderung von `data_retention_months` gilt auch für bestehende Sitzungen, und Sitzungen, die dadurch gelöscht werden, können nicht wiederhergestellt werden; lesen Sie zuerst [Datenaufbewahrung](https://docs.didit.me/de/console/data-retention). Ein API-Schlüssel mit dem Scope `webhooks: write` ist erforderlich. operationId: update_webhook_config parameters: [] requestBody: required: true content: application/json: schema: type: object description: >- Senden Sie nur die zu ändernden Felder. Webhook-Ziele werden hier nicht verwaltet. properties: webhook_url: type: string format: uri nullable: true maxLength: 2000 description: >- Veraltete Webhook-URL auf Anwendungsebene. Didit verwendet diese nur, solange die Anwendung über kein aktiviertes Ziel verfügt, und auch dann nur für `status.updated` und `data.updated`. Sie erstellt kein Ziel, und das nächste Erstellen, Aktualisieren oder Löschen eines Ziels ersetzt sie. Um Webhooks zu empfangen, erstellen Sie stattdessen ein Ziel mit `POST /v3/webhook/destinations/`. webhook_version: type: string enum: - v1 - v2 - v3 description: Payload-Version der Legacy-`webhook_url`. rotate_secret_key: type: boolean default: false description: >- `true` ersetzt den `secret_shared_key` auf Anwendungsebene sofort durch einen neuen Zufallswert; der neue Wert ist in der Antwort enthalten. Ziel-Geheimnisse werden nicht geändert. Jeder Aufruf mit `true` generiert ein neues Geheimnis und ist daher nicht idempotent. capture_method: type: string enum: - MOBILE - MOBILE_AND_DESKTOP description: >- Veraltete Anwendungseinstellung. Der Verifizierungsablauf liest diesen Wert nicht aus. data_retention_months: type: integer nullable: true minimum: 1 maximum: 120 description: >- Automatisches Löschzeitfenster in Monaten (ein Monat zählt als 30 Tage) oder `null` für keine automatische Löschung. Eine Änderung gilt auch für bestehende Sitzungen: Jede Benutzerverifizierungssitzung, die älter als das neue Zeitfenster ist, wird automatisch gelöscht, und diese Löschung ist unwiderruflich. face_retention_policy: type: string enum: - delete_with_session - retain_until_user_deleted description: >- Was mit dem Gesichts-Embedding einer Sitzung passiert, wenn die Sitzung gelöscht wird. `retain_until_user_deleted` erfordert `face_retention_days` in derselben Anfrage oder dass der Wert bereits festgelegt ist. Eine Änderung gilt für Sitzungslöschungen ab diesem Zeitpunkt; sie erstellt oder bereinigt kein bestehendes biometrisches Template. face_retention_days: type: integer nullable: true minimum: 1 maximum: 3650 description: >- Aufbewahrungsfrist in Tagen für biometrische Templates unter `retain_until_user_deleted`. biometric_consent_mode: type: string enum: - auto - always - never description: >- Wann der gehostete Ablauf und die nativen SDKs die Person vor einer Gesichtserfassung um eine ausdrückliche biometrische Einwilligung bitten. `auto` (Standard) fragt nur ab, wenn ein Auslöser zutrifft: Ein angegebener Bundesstaat, die IP-Adresse der Person oder der Aussteller des Ausweisdokuments liegt in Illinois, Texas oder Colorado, oder die Person scheint sich ohne bekannten Bundesstaat in den USA zu befinden. `always` fragt jede Person ab, deren Workflow ein Gesicht erfasst. `never` zeigt den Schritt nie an, und Sie holen die Einwilligung vor dem Selfie selbst ein. Jede Änderung wird im Audit-Log protokolliert. Siehe [Biometrische Einwilligung](https://docs.didit.me/de/getting-started/biometric-consent). allowed_return_hosts: type: array maxItems: 20 description: >- Ersetzt die gesamte Liste der Rückkehr-Hosts für Digital-ID-Wallets. Nur reine Hostnamen wie `shop.example.com`: kein Schema, Port, Pfad oder Wildcard. Werte werden in Kleinbuchstaben umgewandelt und Duplikate entfernt. Senden Sie `[]`, um die Liste zu leeren. items: type: string maxLength: 253 allowed_domains: type: array maxItems: 50 items: type: string maxLength: 300 description: >- Ersetzt die gesamte Liste der zulässigen Origins. Origins (z. B. `https://app.example.com`; `http` nur für `localhost`), in die der gehostete Verifizierungs-Workflow eingebettet werden darf und an die der Benutzer mit einem Sitzungs-Callback zurückgesendet werden darf. Server-zu-Server-Aufrufe sind nicht betroffen. Eine leere Liste bedeutet keine Einschränkung. Didit speichert jeden Origin in Kleinbuchstaben ohne Standard-Port. Ein ungültiger Eintrag schlägt mit `400` für `allowed_domains` fehl. Senden Sie `[]`, um die Einschränkung aufzuheben. example: - https://app.example.com examples: Enable biometric template retention: value: face_retention_policy: retain_until_user_deleted face_retention_days: 365 biometric_consent_mode: auto Rotate the legacy secret: value: rotate_secret_key: true Set data retention: value: data_retention_months: 24 Register return hosts: value: allowed_return_hosts: - shop.example.com - app.example.com responses: '200': description: >- Die vollständige Konfiguration nach der Aktualisierung, in derselben Struktur wie `GET /v3/webhook/`. Wenn Sie das Geheimnis rotiert haben, speichern Sie den neuen `secret_shared_key`, bevor Sie die Antwort verwerfen. content: application/json: schema: $ref: '#/components/schemas/WebhookConfig' examples: Retention enabled: value: webhook_url: https://yourapp.com/webhooks/didit webhook_version: v3 secret_shared_key: dGhpcy1pcy10aGUtYXBwLWxldmVsLXNlY3JldC0wMDA capture_method: MOBILE data_retention_months: 24 face_retention_policy: retain_until_user_deleted face_retention_days: 365 biometric_consent_mode: auto available_events: - value: status.updated label: Session status updated - value: data.updated label: Session data updated - value: user.status.updated label: User status updated - value: user.data.updated label: User data updated - value: business.status.updated label: Business status updated - value: business.data.updated label: Business data updated - value: activity.created label: Activity created - value: transaction.created label: Transaction created - value: transaction.status.updated label: Transaction status updated - value: travel_rule.status.updated label: Travel Rule Status Updated - value: workflow.compliance_changed label: Workflow Compliance Changed allowed_return_hosts: - shop.example.com endpoints: - uuid: 11111111-2222-3333-4444-555555555555 label: Production session webhooks url: https://yourapp.com/webhooks/didit enabled: true webhook_version: v3 secret_shared_key: dGhpcy1pcy1hbi1leGFtcGxlLXNlY3JldC0wMDAwMDA subscribed_events: - status.updated - data.updated created_at: '2026-01-04T08:00:00.000000Z' updated_at: '2026-04-22T14:09:11.523671Z' '400': description: >- Validierung fehlgeschlagen: Jedes ungültige Feld wird einer Liste von Meldungen zugeordnet, und es wird nichts geändert. Ein Body, der kein gültiges JSON ist, gibt `{"detail": "JSON parse error - ..."}` zurück. content: application/json: schema: type: object description: Jedem ungültigen Feld ist eine Liste von Meldungen zugeordnet. additionalProperties: type: array items: type: string examples: Retention days missing: value: face_retention_days: - >- A finite retention duration is required when face retention is enabled. biometric_consent_mode: auto Retention window out of range: value: data_retention_months: - Ensure this value is less than or equal to 120. Invalid return host: value: allowed_return_hosts: - >- 'https://shop.example.com' is not a hostname. Register the bare host (e.g. shop.example.com): no scheme, port, path or wildcard. Invalid choice: value: face_retention_policy: - '"forever" is not a valid choice.' '401': description: >- Der API-Schlüssel ist abgelaufen: Er wurde mit einem Ablaufdatum erstellt, das verstrichen ist. Ein falscher oder widerrufener Schlüssel erhält ebenfalls `401`; ein fehlender Schlüssel erhält `403`. content: application/json: schema: type: object properties: detail: type: string description: Lesbare Fehlermeldung. examples: Expired key: value: detail: This API key has expired. '403': description: >- Die Anfrage ist nicht zulässig. Bei einem fehlenden, ungültigen oder widerrufenen `x-api-key` erhalten Sie `You do not have permission to perform this action.` Ein berechtigungsbeschränkter Schlüssel ohne den für diesen Endpoint erforderlichen Zugriff erhält eine Meldung mit dem fehlenden Zugriff, und ein Schlüssel, der außerhalb seiner IP-Allowlist verwendet wird, erhält `This API key can't be used from this IP address.` content: application/json: schema: type: object properties: detail: type: string description: Lesbare Fehlermeldung. examples: Missing or invalid key: value: detail: You do not have permission to perform this action. Scoped key without webhooks write: value: detail: This API key has no write access to webhooks. Outside the IP allowlist: value: detail: This API key can't be used from this IP address. '429': description: >- Rate-Limit überschritten: Mehr als 300 Schreibanfragen (POST, PATCH, PUT, DELETE) im aktuellen Ein-Minuten-Fenster für diesen API-Schlüssel. Warten Sie `Retry-After` Sekunden vor einem Wiederholungsversuch. headers: Retry-After: description: >- Sekunden, die vor einem Wiederholungsversuch gewartet werden müssen. schema: type: integer minimum: 1 example: 30 X-RateLimit-Limit: description: Im einminütigen Zeitfenster zulässige Anfragen (300). schema: type: integer example: 300 X-RateLimit-Remaining: description: Im aktuellen Zeitfenster verbleibende Anfragen. schema: type: integer example: 0 X-RateLimit-Reset: description: >- Unix-Zeit (Sekunden), zu der das aktuelle Zeitfenster zurückgesetzt wird. schema: type: integer example: 1792056120 X-RateLimit-Scope: description: Name des Budgets, das überschritten wurde. schema: type: string example: generic-write content: application/json: schema: type: object properties: detail: type: string description: Lesbare Fehlermeldung. examples: Throttled: value: detail: >- Write request rate limit exceeded. You can make up to 300 requests per minute. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: |- curl -X PATCH 'https://verification.didit.me/v3/webhook/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"face_retention_policy": "retain_until_user_deleted", "face_retention_days": 365}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.webhooks.update_config( face_retention_policy="retain_until_user_deleted", face_retention_days=365, biometric_consent_mode="auto", ) print(result) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.webhooks.updateConfig({ face_retention_policy: "retain_until_user_deleted", face_retention_days: 365, biometric_consent_mode: "auto", }); console.log(result); - lang: java label: Java source: >- import me.didit.Didit; import me.didit.types.WebhooksUpdateConfigParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.webhooks().updateConfig(WebhooksUpdateConfigParams.builder() .faceRetentionPolicy(WebhooksUpdateConfigParams.FaceRetentionPolicy.of("retain_until_user_deleted")) .faceRetentionDays(365L) .biometricConsentMode(WebhooksUpdateConfigParams.BiometricConsentMode.of("auto")) .build()); System.out.println(result); - lang: php label: PHP source: |- webhooks->updateConfig([ 'face_retention_policy' => 'retain_until_user_deleted', 'face_retention_days' => 365, 'biometric_consent_mode' => 'auto', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.webhooks.update_config( face_retention_policy: "retain_until_user_deleted", face_retention_days: 365, biometric_consent_mode: "auto" ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Webhooks.UpdateConfigAsync(new WebhooksUpdateConfigParams { FaceRetentionPolicy = new WebhooksUpdateConfigParamsFaceRetentionPolicy("retain_until_user_deleted"), FaceRetentionDays = 365, BiometricConsentMode = new WebhooksUpdateConfigParamsBiometricConsentMode("auto"), }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: WebhookConfig: type: object description: >- Webhook-Konfiguration auf Anwendungsebene, Aufbewahrungsrichtlinie und Hosts für die Rückgabe der Digital-ID-Wallet sowie alle Webhook-Ziele. required: - webhook_url - webhook_version - secret_shared_key - capture_method - data_retention_months - face_retention_policy - face_retention_days - available_events - allowed_return_hosts - endpoints properties: webhook_url: type: string format: uri nullable: true description: >- Webhook-URL auf Anwendungsebene (Legacy). Didit sendet nur daran, solange die Anwendung kein aktiviertes Ziel hat, und dann nur `status.updated` und `data.updated`. Jedes Erstellen, Aktualisieren oder Löschen eines Ziels setzt sie auf die URL des ältesten aktivierten Ziels bzw. auf `null`, wenn keines aktiviert ist. webhook_version: type: string enum: - v1 - v2 - v3 description: >- Payload-Version der Legacy-`webhook_url`. Jedes Ziel hat eine eigene `webhook_version`. secret_shared_key: type: string description: >- Signaturgeheimnis auf Anwendungsebene (43 Zeichen langes URL-sicheres Token). Es signiert ausschließlich Zustellungen an die Legacy-`webhook_url`; jedes Ziel signiert mit seinem eigenen `secret_shared_key`. Aufrufer mit API-Schlüssel erhalten es immer vollständig; Console-Benutzer ohne `read:webhooks` erhalten eine leere Zeichenfolge. capture_method: type: string enum: - MOBILE - MOBILE_AND_DESKTOP description: >- Veraltete Anwendungseinstellung. Der Verifizierungsablauf liest diesen Wert nicht aus: Erfassungsoptionen werden pro Workflow konfiguriert. data_retention_months: type: integer nullable: true minimum: 1 maximum: 120 description: >- Automatisches Löschfenster. Sitzungen zur Benutzerverifizierung, die vor mehr als der angegebenen Anzahl von Monaten erstellt wurden (ein Monat entspricht 30 Tagen), werden automatisch gelöscht, und diese Löschung ist unwiderruflich. `null` bedeutet, dass Sitzungen niemals automatisch gelöscht werden. Siehe [Datenaufbewahrung](https://docs.didit.me/de/console/data-retention). face_retention_policy: type: string enum: - delete_with_session - retain_until_user_deleted description: >- Was mit dem Gesichts-Embedding einer Sitzung passiert, wenn die Sitzung gelöscht wird. `delete_with_session` (Standard) löscht es mit der Sitzung. `retain_until_user_deleted` ist das Opt-in für die [Aufbewahrung biometrischer Templates](https://docs.didit.me/de/console/data-retention#aufbewahrung-biometrischer-templates): Ein mit dem Benutzer verknüpftes bildfreies biometrisches Template wird separat verwaltet, bis seine Aufbewahrungsfrist endet, der Benutzer gelöscht wird oder Sie es bereinigen. face_retention_days: type: integer nullable: true minimum: 1 maximum: 3650 description: >- Aufbewahrungsfrist in Tagen für biometrische Templates unter `retain_until_user_deleted`. Erforderlich, wenn diese Richtlinie festgelegt ist. biometric_consent_mode: type: string enum: - auto - always - never description: >- Wann der gehostete Ablauf und die nativen SDKs die Person vor einer Gesichtserfassung um eine ausdrückliche biometrische Einwilligung bitten. `auto` (Standard) fragt nur ab, wenn ein Auslöser zutrifft: Ein angegebener Bundesstaat, die IP-Adresse der Person oder der Aussteller des Ausweisdokuments liegt in Illinois, Texas oder Colorado, oder die Person scheint sich ohne bekannten Bundesstaat in den USA zu befinden. `always` fragt jede Person ab, deren Workflow ein Gesicht erfasst. `never` zeigt den Schritt nie an, und Sie holen die Einwilligung vor dem Selfie selbst ein. Jede Änderung wird im Audit-Log protokolliert. Siehe [Biometrische Einwilligung](https://docs.didit.me/de/getting-started/biometric-consent). available_events: type: array description: >- Jeder Ereignistyp, den ein Ziel abonnieren kann, mit einer Anzeigebezeichnung. items: type: object required: - value - label properties: value: $ref: '#/components/schemas/WebhookEvent' label: type: string description: Anzeigebezeichnung, zum Beispiel `Session status updated`. allowed_return_hosts: type: array maxItems: 20 description: >- Hostnamen (exakte Übereinstimmung, nur HTTPS), zu denen eine eigenständige Digital-ID-Wallet-Verifizierung den Benutzer mit ihrer `return_url` zurücksenden darf. Ihre White-Label-Domain ist ebenfalls stets zulässig. Siehe [Registrieren Sie Ihr Rückkehrziel](https://docs.didit.me/de/standalone-apis/digital-id-wallets#ihr-rückgabeziel-registrieren). items: type: string maxLength: 253 endpoints: type: array description: >- Jedes Webhook-Ziel der Anwendung, das älteste zuerst, jeweils mit seinem Signaturgeheimnis. Hier schreibgeschützt: Verwalten Sie Ziele über die `/v3/webhook/destinations/`-Endpoints. items: $ref: '#/components/schemas/WebhookConfigDestination' allowed_domains: type: array maxItems: 50 items: type: string maxLength: 300 description: >- Origins (zum Beispiel `https://app.example.com`; `http` nur für `localhost`), in die der gehostete Verifizierungs-Workflow eingebettet werden darf und an die der Benutzer mit einem Sitzungs-Callback zurückgeleitet werden darf. Server-zu-Server-Aufrufe sind davon nicht betroffen. Eine leere Liste bedeutet keine Einschränkung. Didit speichert jeden Origin in Kleinbuchstaben ohne Standard-Port. Ein ungültiger Eintrag schlägt mit `400` bei `allowed_domains` fehl. example: - https://app.example.com WebhookEvent: type: string description: >- Name des unterstützten Webhook-Ereignisses. Verwenden Sie genau diese Zeichenfolgen in `subscribed_events`; nicht unterstützte Werte werden abgelehnt. enum: - 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 WebhookConfigDestination: type: object description: >- Ein Webhook-Ziel wie in der Webhook-Konfiguration aufgeführt, ohne Zustellungsmetriken. `GET /v3/webhook/destinations/{destination_uuid}/` fügt dessen Zustellungsübersicht hinzu. required: - uuid - label - url - enabled - webhook_version - secret_shared_key - subscribed_events - created_at - updated_at properties: uuid: type: string format: uuid description: Ziel-ID. label: type: string maxLength: 255 description: Für Menschen lesbarer Name. url: type: string format: uri maxLength: 2000 description: HTTPS-Endpoint, an den Didit Ereignisse sendet. enabled: type: boolean description: '`false` pausiert Zustellungen an dieses Ziel.' webhook_version: type: string enum: - v1 - v2 - v3 description: Payload-Version, die an dieses Ziel gesendet wird. secret_shared_key: type: string description: >- Das Signaturgeheimnis dieses Ziels (URL-sicherer Token mit 43 Zeichen). Verifizieren Sie jeden Webhook mit dem Geheimnis des Ziels, an das er gesendet wurde. Aufrufer mit API-Schlüssel erhalten es immer vollständig; Console-Benutzer ohne `read:webhooks` erhalten eine leere Zeichenfolge. subscribed_events: type: array uniqueItems: true description: >- Ereignistypen, die an dieses Ziel zugestellt werden. Leer, wenn das Ziel ohne Ereignisse erstellt wurde; in diesem Fall empfängt es nichts. items: $ref: '#/components/schemas/WebhookEvent' created_at: type: string format: date-time updated_at: type: string format: date-time securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.