> ## 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 配置 API

> 通过 Didit 修改应用级 Webhook、轮换其共享密钥、设置数据与生物特征模板保留期，并注册数字身份钱包的回跳主机。



更新 Webhook 配置 API 提示词
        将提示词复制到剪贴板



      
      

\<pre>

\`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.`

\</pre>



      
      

粘贴到

> [!NOTE]
>
> `rotate_secret_key` 仅轮换应用级密钥，该密钥用于对发送到旧版 `webhook_url` 的投递进行签名。每个 [Webhook 目标](https://docs.didit.me/zh/management-api/webhook/list-destinations.md) 都使用其自己的 `secret_shared_key` 签名，此调用不会更改该密钥。保留字段与您在 **Business Console → App Settings → Data retention** 中设置的策略相同。更改这些字段前，请先阅读[数据保留](https://docs.didit.me/zh/console/data-retention.md)，尤其是[生物特征模板保留](https://docs.didit.me/zh/console/data-retention.md#生物特征模板保留)。`allowed_return_hosts` 在[注册返回目标](https://docs.didit.me/zh/standalone-apis/digital-id-wallets.md#注册返回目标)中有所说明。`biometric_consent_mode`（`auto`、`always` 或 `never`）用于设置验证流程在人脸采集前何时请求明确的生物特征同意。请参阅[生物特征同意](https://docs.didit.me/zh/getting-started/biometric-consent.md)。如需先读取当前值，请调用[获取 Webhook 配置](https://docs.didit.me/zh/management-api/webhook/get-config.md)。


## OpenAPI

````yaml zh/openapi-25.json PATCH /v3/webhook/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: 身份证件验证 API。使用 x-api-key 请求头进行身份验证。
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/webhook/:
    patch:
      tags:
        - Webhook
      summary: 更新 Webhook 配置
      description: >-
        部分更新应用级设置：旧版 Webhook URL、版本与密钥，数据及生物特征模板保留策略，以及 Digital ID
        钱包返回主机。仅发送需更改的字段；响应为完整配置，数据结构与 `GET /v3/webhook/` 相同。此处不管理目标：请通过
        `/v3/webhook/destinations/` endpoint 进行创建、更新和删除，且不要向此 endpoint 发送
        `endpoints` 字段。`data_retention_months`
        的更改同样适用于现有会话，且其删除的会话无法恢复；请先阅读[数据保留](https://docs.didit.me/zh/console/data-retention)。限定范围的
        API 密钥需要具备 `webhooks: write` 权限。
      operationId: update_webhook_config
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 仅发送要更改的字段。目标不在此处管理。
              properties:
                webhook_url:
                  type: string
                  format: uri
                  nullable: true
                  maxLength: 2000
                  description: >-
                    旧版应用级 Webhook URL。Didit 仅在应用未启用任何目标时使用它，且仅用于
                    `status.updated` 和
                    `data.updated`。它不会创建目标，并且下次对目标的创建、更新或删除操作都会替换它。若要接收
                    Webhook，请改用 `POST /v3/webhook/destinations/` 创建目标。
                webhook_version:
                  type: string
                  enum:
                    - v1
                    - v2
                    - v3
                  description: 传统 `webhook_url` 的 payload 版本。
                rotate_secret_key:
                  type: boolean
                  default: false
                  description: >-
                    `true` 会立即将应用层级的 `secret_shared_key`
                    替换为新的随机值；新值包含在响应中。目标密钥不会更改。每次传入 `true`
                    的调用都会生成一个新密钥，因此该操作不具备幂等性。
                capture_method:
                  type: string
                  enum:
                    - MOBILE
                    - MOBILE_AND_DESKTOP
                  description: 旧版应用设置。验证流程不会读取它。
                data_retention_months:
                  type: integer
                  nullable: true
                  minimum: 1
                  maximum: 120
                  description: >-
                    自动删除期限（以月为单位，一个月计为 30 天），或填 `null`
                    表示不自动删除。更改同样适用于现有会话：早于新设定月限的所有用户验证会话都将被自动删除，且该删除操作不可逆。
                face_retention_policy:
                  type: string
                  enum:
                    - delete_with_session
                    - retain_until_user_deleted
                  description: >-
                    当会话被删除时，对该会话的人脸特征向量的处理方式。`retain_until_user_deleted`
                    要求在同一次请求中提供 `face_retention_days`
                    或已预先设置该参数。变更仅适用于此后的会话删除；不会创建或清除任何现有的生物特征模板。
                face_retention_days:
                  type: integer
                  nullable: true
                  minimum: 1
                  maximum: 3650
                  description: 在 `retain_until_user_deleted` 策略下生物特征模板的保留期（以天为单位）。
                biometric_consent_mode:
                  type: string
                  enum:
                    - auto
                    - always
                    - never
                  description: >-
                    托管流程和原生 SDK
                    何时在人脸采集前向当事人请求明确的生物识别同意。`auto`（默认）仅在适用触发条件时请求：当事人声明的州、当事人的
                    IP 或身份证件签发地位于伊利诺伊州、德克萨斯州或科罗拉多州，或者当事人看似位于美国境内且所在州未知。`always`
                    会向工作流中需要采集人脸的每个人请求。`never`
                    则从不显示该步骤，由您在拍摄自拍照前自行收集同意。每次更改都会记录在审计日志中。请参阅[生物识别同意](https://docs.didit.me/zh/getting-started/biometric-consent)。
                allowed_return_hosts:
                  type: array
                  maxItems: 20
                  description: >-
                    替换数字身份钱包返回主机的整个列表。仅支持纯主机名，例如
                    `shop.example.com`：不支持协议、端口、路径或通配符。值将转换为小写并删除重复项。发送 `[]`
                    以清空列表。
                  items:
                    type: string
                    maxLength: 253
                allowed_domains:
                  type: array
                  maxItems: 50
                  items:
                    type: string
                    maxLength: 300
                  description: >-
                    替换允许的源（origins）的整个列表。托管验证流程可以嵌入其中并通过会话回调将用户发送回这些源（例如
                    `https://app.example.com`；`http` 仅适用于
                    `localhost`）。服务器到服务器的调用不受影响。空列表表示没有限制。Didit
                    以小写形式存储每个源，不包含默认端口。无效条目会针对 `allowed_domains` 返回 `400`。发送
                    `[]` 以移除限制。
                  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: >-
            更新后的完整配置，结构与 `GET /v3/webhook/` 相同。轮换密钥时，请在丢弃响应前存储新的
            `secret_shared_key`。
          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: >-
            验证失败：每个无效字段都会映射到一个消息列表，且不会更改任何内容。非有效 JSON 的请求主体将返回 `{"detail": "JSON
            parse error - ..."}`。
          content:
            application/json:
              schema:
                type: object
                description: 每个无效字段映射到的消息列表。
                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: API 密钥已过期：它在创建时设置的到期日期已过。错误或已撤销的密钥也会收到 `401`；缺失密钥则收到 `403`。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: 便于人类阅读的错误消息。
              examples:
                Expired key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            该请求不被允许。缺失、无效或已撤销的 `x-api-key` 会收到 `You do not have permission to
            perform this action.`。缺少此 endpoint 所需访问权限的限定作用域密钥会收到指明所缺权限的消息，而在其 IP
            白名单之外使用的密钥会收到 `This API key can't be used from this IP address.`。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: 便于人类阅读的错误消息。
              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: >-
            超出速率限制：当前一分钟窗口内该 API 密钥的写入请求（POST、PATCH、PUT、DELETE）超过 300 次。请等待
            `Retry-After` 秒后再重试。
          headers:
            Retry-After:
              description: 重试前需要等待的秒数。
              schema:
                type: integer
                minimum: 1
                example: 30
            X-RateLimit-Limit:
              description: 一分钟时间窗口内允许的请求数（300）。
              schema:
                type: integer
                example: 300
            X-RateLimit-Remaining:
              description: 当前时间窗口内剩余的请求数。
              schema:
                type: integer
                example: 0
            X-RateLimit-Reset:
              description: 当前窗口重置的 Unix 时间（秒）。
              schema:
                type: integer
                example: 1792056120
            X-RateLimit-Scope:
              description: 发生超支的预算名称。
              schema:
                type: string
                example: generic-write
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: 便于人类阅读的错误消息。
              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: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

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

            $result = $didit->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 配置、保留策略和数字身份（Digital ID）钱包返回主机，以及所有 Webhook 目标。
      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。Didit 仅在应用没有已启用的目标时才向其发送事件，且仅发送 `status.updated`
            和 `data.updated`。每次创建、更新或删除目标时，都会将其设置为最早启用的目标的 URL；若无已启用的目标，则设置为
            `null`。
        webhook_version:
          type: string
          enum:
            - v1
            - v2
            - v3
          description: 传统 `webhook_url` 的 payload 版本。每个目标都有其独立的 `webhook_version`。
        secret_shared_key:
          type: string
          description: >-
            应用级签名密钥（43 字符的 URL 安全 token）。它仅对投递到旧版 `webhook_url`
            的事件进行签名；每个目标则使用各自的 `secret_shared_key` 进行签名。通过 API
            密钥调用的调用方始终会完整接收该密钥；没有 `read:webhooks` 权限的控制台用户将收到空字符串。
        capture_method:
          type: string
          enum:
            - MOBILE
            - MOBILE_AND_DESKTOP
          description: 旧版应用设置。验证流程不会读取它：采集选项按工作流进行配置。
        data_retention_months:
          type: integer
          nullable: true
          minimum: 1
          maximum: 120
          description: >-
            自动删除窗口。在此月数以前（一个月按 30 天计算）创建的用户验证会话将被自动删除，且该删除不可逆。`null`
            表示会话绝不会被自动删除。参见[数据保留](https://docs.didit.me/zh/console/data-retention)。
        face_retention_policy:
          type: string
          enum:
            - delete_with_session
            - retain_until_user_deleted
          description: >-
            当会话被删除时，对该会话的人脸特征向量的处理方式。`delete_with_session`（默认）会随会话一同将其删除。`retain_until_user_deleted`
            为自选的[生物特征模板保留](https://docs.didit.me/zh/console/data-retention#生物特征模板保留)：与用户关联的不含图像的生物特征模板会被单独管理，直至其数据保留期结束、用户被删除或您主动清除它。
        face_retention_days:
          type: integer
          nullable: true
          minimum: 1
          maximum: 3650
          description: 在 `retain_until_user_deleted` 策略下生物特征模板的保留期（以天为单位）。设置该策略时必填。
        biometric_consent_mode:
          type: string
          enum:
            - auto
            - always
            - never
          description: >-
            托管流程和原生 SDK
            何时在人脸采集前向当事人请求明确的生物识别同意。`auto`（默认）仅在适用触发条件时请求：当事人声明的州、当事人的 IP
            或身份证件签发地位于伊利诺伊州、德克萨斯州或科罗拉多州，或者当事人看似位于美国境内且所在州未知。`always`
            会向工作流中需要采集人脸的每个人请求。`never`
            则从不显示该步骤，由您在拍摄自拍照前自行收集同意。每次更改都会记录在审计日志中。请参阅[生物识别同意](https://docs.didit.me/zh/getting-started/biometric-consent)。
        available_events:
          type: array
          description: 目标可以订阅的每种事件类型，附带显示标签。
          items:
            type: object
            required:
              - value
              - label
            properties:
              value:
                $ref: '#/components/schemas/WebhookEvent'
              label:
                type: string
                description: 显示标签，例如 `Session status updated`。
        allowed_return_hosts:
          type: array
          maxItems: 20
          description: >-
            独立数字身份钱包验证可通过其 `return_url` 将用户送回的主机名（精确匹配，仅限
            HTTPS）。您的白标域名也始终被允许。请参阅[注册您的返回目标](https://docs.didit.me/zh/standalone-apis/digital-id-wallets#注册返回目标)。
          items:
            type: string
            maxLength: 253
        endpoints:
          type: array
          description: >-
            该应用的每个 Webhook 目标，按时间正序排列，每个目标均附带其签名密钥。此处为只读：使用
            `/v3/webhook/destinations/` 系列 endpoint 管理目标。
          items:
            $ref: '#/components/schemas/WebhookConfigDestination'
        allowed_domains:
          type: array
          maxItems: 50
          items:
            type: string
            maxLength: 300
          description: >-
            托管验证流程可以嵌入并可通过会话回调将用户重定向回的源（Origin，例如
            `https://app.example.com`；`http` 仅适用于
            `localhost`）。服务器到服务器的调用不受影响。空列表表示无限制。Didit
            会将每个源以小写形式存储，且不包含默认端口。无效条目将导致 `allowed_domains` 验证失败并返回 `400`。
          example:
            - https://app.example.com
    WebhookEvent:
      type: string
      description: 支持的 Webhook 事件名称。请在 `subscribed_events` 中使用这些完全匹配的字符串；不支持的值将被拒绝。
      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: >-
        Webhook 配置中列出的 Webhook 目标，不包含投递指标。`GET
        /v3/webhook/destinations/{destination_uuid}/` 会附加其投递摘要。
      required:
        - uuid
        - label
        - url
        - enabled
        - webhook_version
        - secret_shared_key
        - subscribed_events
        - created_at
        - updated_at
      properties:
        uuid:
          type: string
          format: uuid
          description: 目标 ID。
        label:
          type: string
          maxLength: 255
          description: 易于阅读的名称。
        url:
          type: string
          format: uri
          maxLength: 2000
          description: Didit 发送事件通知的 HTTPS endpoint。
        enabled:
          type: boolean
          description: '`false` 会暂停向此目标投递。'
        webhook_version:
          type: string
          enum:
            - v1
            - v2
            - v3
          description: 发送至该目标的 payload 版本。
        secret_shared_key:
          type: string
          description: >-
            此目标的签名密钥（43 字符的 URL 安全 token）。请使用发送该 Webhook 的目标的密钥来验证每个 Webhook。使用
            API 密钥调用的调用方始终会接收完整密钥；没有 `read:webhooks` 权限的控制台用户将收到空字符串。
        subscribed_events:
          type: array
          uniqueItems: true
          description: 投递至此目标的事件类型。如果目标创建时未指定事件，则为空，在此情况下它不会接收任何内容。
          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: >-
        您的应用 API 密钥，可在 Business Console 的“开发者 -> API
        密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域：针对每个资源设为无权限、只读或读写，限定于特定工作流或已通过的会话、限定于
        IP 地址列表，以及设置到期日期。401 表示密钥错误、已撤销或已过期；403 表示未发送密钥、密钥无权访问该资源或操作，或请求来自其 IP
        列表之外的地址；在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF
        URL 将为 null；没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅
        https://docs.didit.me/console/api-keys。

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.