> ## 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 目标的每次投递尝试，按最新优先排序，并包含 HTTP 状态、响应时间和事件类型。



列出 Webhook 目标投递记录 API 提示词
        将提示词复制到剪贴板



      
      

\<pre>

\`List the delivery attempts made to one Didit webhook destination through the Management API.

Endpoint:
GET https://verification.didit.me/v3/webhook/destinations/{destination_uuid}/deliveries/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs webhooks: read and decisions: read. A key limited to some workflows or to approved sessions cannot use this endpoint.

Goal:
\- Find the webhooks my endpoint failed to accept, so I can fix the endpoint and resend them.

Path parameter:
\- destination_uuid: the destination uuid from GET /v3/webhook/destinations/.

Query parameters (optional):
\- limit (default 50) and offset for pagination.
\- date_from, date_to: UTC days as YYYY-MM-DD, both inclusive.

Behavior:
\- Newest first. Every attempt is its own entry: the first send of an event, each automatic retry and each resend.
\- Response: { count, next, previous, results }. count is exact up to 100 and reads 100 above that, so follow next until it is null instead of computing pages from count.
\- Entries do not carry the payload. Fetch one with GET /v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/ to read the headers and body.

Example call:
curl -X GET "https://verification.didit.me/v3/webhook/destinations/{destination_uuid}/deliveries/?limit=50&date_from=2026-05-01" \
-H "x-api-key: YOUR_API_KEY"

What to read from each result:
\- uuid: the delivery id, for the detail and resend calls.
\- response_status: what my endpoint answered. null means the attempt has not been made yet; 504 is a timeout, 503 a connection failure, 400 a URL Didit refused to call, 404 any other request error; 400 or above is a failure.
\- Delivery records are available for about 30 days.
\- response_time_ms, created_at, webhook_type, status, request_url.
\- session_id: the verification session the event is about, or null for business, user, transaction and other events.

Failure modes:
\- 400: invalid date_from or date_to, date_to earlier than date_from, or limit or offset above 1000000.
\- 401: { "detail": "This API key has expired." }
\- 403: { "detail": "You do not have permission to perform this action." }, { "detail": "This API key has no read access to webhooks." }, { "detail": "This API key has no read access to decisions." }, or the limited-key message.
\- 404: { "detail": "Webhook destination not found." }
\- 429: more than 600 GET requests per minute with this key; wait for Retry-After.

Side effects: none. This is a pure read.

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

\</pre>



      
      

粘贴到

投递记录是 Didit 向此目标发送 Webhook 的每次尝试。自动重试遵循[重试策略](https://docs.didit.me/zh/integration/webhooks.md#重试策略)，每次重试都会单独显示为一条记录。修复 endpoint 后如需重新发送某条记录，请调用 [重新发送 Webhook 目标投递](https://docs.didit.me/zh/management-api/webhook/resend-delivery.md)。如需查看某一时间段的汇总数据，请使用 [获取 Webhook 目标分析数据](https://docs.didit.me/zh/management-api/webhook/destination-analytics.md)。


## OpenAPI

````yaml zh/openapi-25.json GET /v3/webhook/destinations/{destination_uuid}/deliveries/
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/destinations/{destination_uuid}/deliveries/:
    get:
      tags:
        - Webhook
      summary: 列出 Webhook 目标投递记录
      description: >-
        分页查看向单个 Webhook
        目标发送的每次投递尝试，最新优先。每个事件的首次发送、每次自动[重试](https://docs.didit.me/zh/integration/webhooks#重试策略)和每次重新发送均为独立条目。条目包含
        HTTP 状态和响应时间，但不包含 payload：获取单个投递记录以读取其请求头和正文。`count` 在 100
        以内是精确的，超过该值则显示为 100，因此请持续追踪 `next` 直至其为 `null`。投递记录保留约 30 天。受权限范围限制的 API
        密钥需要 `webhooks: read` 和 `decisions: read` 权限；限定于特定工作流或仅限已通过会话的密钥无法使用此
        endpoint。
      operationId: list_webhook_destination_deliveries
      parameters:
        - name: destination_uuid
          in: path
          required: true
          description: 目标的 UUID（`GET /v3/webhook/destinations/` 返回的 `uuid`）。
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
        - name: limit
          in: query
          required: false
          description: 每页最大投递数。默认值为 50。非正整数值将回退至 50；超过 1000000 的值将返回 `400`。
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
          example: 50
        - name: offset
          in: query
          required: false
          description: 要跳过的投递数量。默认为 0。建议使用响应中的 `next` 和 `previous` URL。
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
          example: 0
        - name: date_from
          in: query
          required: false
          description: 包含的首个 UTC 日期，格式为 `YYYY-MM-DD`（含）。省略则从最早可用的投递开始。支持将 `dateFrom` 作为别名。
          schema:
            type: string
            format: date
          example: '2026-10-01'
        - name: date_to
          in: query
          required: false
          description: >-
            要包含的最后一个 UTC 日期，格式为 `YYYY-MM-DD`（含）。不得早于 `date_from`。可接受 `dateTo`
            作为别名。
          schema:
            type: string
            format: date
          example: '2026-10-16'
      responses:
        '200':
          description: 一页投递记录，最新的排在最前。
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - next
                  - previous
                  - results
                properties:
                  count:
                    type: integer
                    minimum: 0
                    description: 匹配的投递，100 条以内为精确值，超过 100 条时上限显示为 100。使用 `next` 了解是否存在更多页面。
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: 下一页的绝对 URL，最后一页则为 `null`。
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: 上一页的绝对 URL，第一页则为 `null`。
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookDestinationDelivery'
              examples:
                Failed delivery, its retry and a queued event:
                  value:
                    count: 3
                    next: null
                    previous: null
                    results:
                      - uuid: 66666666-7777-8888-9999-000000000003
                        session_id: null
                        request_url: https://yourapp.com/webhooks/didit
                        response_status: null
                        response_time_ms: null
                        status: APPROVED
                        webhook_type: transaction.created
                        created_at: '2026-10-15T09:23:02.871190Z'
                      - uuid: 66666666-7777-8888-9999-000000000002
                        session_id: 22222222-3333-4444-5555-666666666666
                        request_url: https://yourapp.com/webhooks/didit
                        response_status: 200
                        response_time_ms: 143
                        status: In Progress
                        webhook_type: status.updated
                        created_at: '2026-10-15T09:22:19.104233Z'
                      - uuid: 66666666-7777-8888-9999-000000000001
                        session_id: 22222222-3333-4444-5555-666666666666
                        request_url: https://yourapp.com/webhooks/didit
                        response_status: 503
                        response_time_ms: 412
                        status: In Progress
                        webhook_type: status.updated
                        created_at: '2026-10-15T09:21:18.412345Z'
        '400':
          description: >-
            `date_from` 或 `date_to` 不是 `YYYY-MM-DD` 格式的日期、`date_to` 早于
            `date_from`，或者 `limit` 或 `offset` 大于 1000000（该错误是一个包含多条消息的 JSON 数组）。
          content:
            application/json:
              examples:
                Malformed date:
                  value:
                    date_from:
                      - >-
                        Date has wrong format. Use one of these formats instead:
                        YYYY-MM-DD.
                Reversed range:
                  value:
                    date_to:
                      - date_to must be greater than or equal to date_from.
                Limit too large:
                  value:
                    - limit must not exceed 1000000.
        '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.`。仅限于某些工作流或已通过的会话的密钥会收到 `This API key only reaches sessions
            inside its workflow or status limits, so it can't use this
            endpoint.`。
          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 read:
                  value:
                    detail: This API key has no read access to webhooks.
                Scoped key without decisions read:
                  value:
                    detail: This API key has no read access to decisions.
                Key limited to workflows or approved sessions:
                  value:
                    detail: >-
                      This API key only reaches sessions inside its workflow or
                      status limits, so it can't use this endpoint.
                Outside the IP allowlist:
                  value:
                    detail: This API key can't be used from this IP address.
        '404':
          description: 应用不存在具有此 UUID 的目标，或者已被删除。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: 便于人类阅读的错误消息。
              examples:
                Destination not found:
                  value:
                    detail: Webhook destination not found.
        '429':
          description: 超出速率限制：当前一分钟窗口内该 API 密钥的 GET 请求超过 600 次。请等待 `Retry-After` 秒后再重试。
          headers:
            Retry-After:
              description: 重试前需要等待的秒数。
              schema:
                type: integer
                minimum: 1
                example: 30
            X-RateLimit-Limit:
              description: 一分钟时间窗口内允许的请求数（600）。
              schema:
                type: integer
                example: 600
            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-get
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: 便于人类阅读的错误消息。
              examples:
                Throttled:
                  value:
                    detail: >-
                      GET request rate limit exceeded. You can make up to 600
                      requests per minute.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/deliveries/?limit=50&date_from=2026-10-01'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            for item in client.webhooks.destinations.list_deliveries(
                "11111111-2222-3333-4444-555555555555",
            ):
                print(item)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            for await (const item of
            didit.webhooks.destinations.listDeliveries("11111111-2222-3333-4444-555555555555"))
            {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Webhooks.Destinations.ListDeliveriesAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WebhooksDestinationsListDeliveriesParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            for (var item :
            client.webhooks().destinations().listDeliveries("11111111-2222-3333-4444-555555555555"))
            {
                System.out.println(item);
            }
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            foreach
            ($didit->webhooks->destinations->listDeliveries('11111111-2222-3333-4444-555555555555')
            as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            didit.webhooks.destinations.list_deliveries("11111111-2222-3333-4444-555555555555").auto_paging_each
            do |item|
              puts item.to_h
            end
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            await foreach (var item in await
            client.Webhooks.Destinations.ListDeliveriesAsync("11111111-2222-3333-4444-555555555555"))

            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    WebhookDestinationDelivery:
      type: object
      description: 向 Webhook 目标发送的一次投递尝试。事件的首次发送、每次自动重试以及每次重新发送均作为独立的投递记录。
      required:
        - uuid
        - session_id
        - request_url
        - response_status
        - response_time_ms
        - status
        - webhook_type
        - created_at
      properties:
        uuid:
          type: string
          format: uuid
          description: 投递 ID，用于获取详情和重新发送调用。
        session_id:
          type: string
          format: uuid
          nullable: true
          description: 该事件涉及的用户验证会话。对于企业会话、用户、企业、交易、Travel Rule 和工作流事件为 `null`。
        request_url:
          type: string
          format: uri
          nullable: true
          description: 投递发送的目标 URL：生成事件时目标的 URL。
        response_status:
          type: integer
          nullable: true
          description: >-
            您的 endpoint 返回的 HTTP 状态码。在投递已排队且尚未尝试时为 `null`。未收到 HTTP 响应时，Didit
            会记录自身的状态码：您的 endpoint 未在 5 秒内响应记录为 `504`，连接失败记录为 `503`，因 URL
            不安全而被拒绝（例如私有或内部地址）记录为 `400`，其他任何请求错误记录为 `404`。`400` 或更高视为投递失败。
        response_time_ms:
          type: integer
          nullable: true
          minimum: 0
          description: 尝试所花费的时间，以毫秒为单位。投递处于队列中时为 `null`。
        status:
          type: string
          nullable: true
          description: >-
            事件生成时报告的状态：会话事件对应会话状态（例如 `Approved` 或 `In
            Review`），用户和企业事件对应个人或公司的状态，交易事件对应交易状态。对于不携带状态的事件为 `null`。
        webhook_type:
          $ref: '#/components/schemas/WebhookEvent'
        created_at:
          type: string
          format: date-time
          description: 投递创建的时间。
    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
  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.