> ## Documentation Index
> Fetch the complete documentation index at: https://adp-doc.laiye.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 查询 Webhook 事件目录

> 返回当前服务注册、可用于配置订阅的系统事件类型。事件目录只说明事件名称可被配置，不等于每种事件都已提供投递 SLA；回调 data 的字段也可能因事件而异。

当前目录包含文档解析完成、文档抽取完成，以及人工协作开始/成功/失败/完成/超时等 7 个事件。collaboration_timeout 当前仅表示已注册事件，不承诺一定产生实际投递。




## OpenAPI

````yaml api-reference/adp-api.yaml GET /open/agentic_doc_processor/{tenant_name}/v1/webhook/events
openapi: 3.1.0
info:
  title: ADP API
  version: 1.0.0
  description: >-
    Laiye ADP 官方 OpenAPI
    接口规范，覆盖文档抽取、解析与转换，抽取应用管理、Webhook、人机协同、积分查询，以及工作流发现、运行、导出和文件管理。
  license:
    name: MIT
    identifier: MIT
servers:
  - url: https://adp.laiye.com
    description: ADP 生产环境
security: []
tags:
  - name: 文档抽取
    description: 从上传的文档中抽取结构化字段。
  - name: 文档解析
    description: 识别上传文档中的文字、版面块和位置信息。
  - name: 文档转换
    description: 将 PDF、Office、OFD 和图片转换为页面图片或电子表格结构。
  - name: 应用管理
    description: 创建、修改、删除和查询抽取应用及配置。
  - name: Webhook
    description: 查询事件目录并管理事件回调。
  - name: 账户
    description: 查询账户积分和使用情况。
  - name: 工作流
    description: 查询业务工作流模板、运行工作流应用并查询执行结果。
  - name: 工作流文件
    description: 上传和管理工作流应用使用的文件。
  - name: 人机协同
    description: 配置审核触发规则，查询协同任务并提交人工修正。
paths:
  /open/agentic_doc_processor/{tenant_name}/v1/webhook/events:
    get:
      tags:
        - Webhook
      summary: 查询 Webhook 事件目录
      description: >
        返回当前服务注册、可用于配置订阅的系统事件类型。事件目录只说明事件名称可被配置，不等于每种事件都已提供投递 SLA；回调 data
        的字段也可能因事件而异。


        当前目录包含文档解析完成、文档抽取完成，以及人工协作开始/成功/失败/完成/超时等 7 个事件。collaboration_timeout
        当前仅表示已注册事件，不承诺一定产生实际投递。
      operationId: listWebhookEvents
      parameters:
        - $ref: '#/components/parameters/TenantName'
      responses:
        '200':
          $ref: '#/components/responses/WebhookEventListResponse'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    TenantName:
      name: tenant_name
      in: path
      required: true
      description: 租户名称，默认 laiye。
      schema:
        type: string
        default: laiye
  responses:
    WebhookEventListResponse:
      description: Webhook 系统事件目录。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WebhookEventListResponse'
    ValidationError:
      description: 参数校验错误。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/HTTPValidationError'
          example:
            detail:
              - type: greater_than
                loc:
                  - query
                  - limit
                msg: Input should be greater than 0
                input: 0
                ctx:
                  gt: 0
  schemas:
    WebhookEventListResponse:
      allOf:
        - $ref: '#/components/schemas/SimpleResponse'
        - type: object
          properties:
            data:
              type: object
              properties:
                events:
                  type: array
                  items:
                    $ref: '#/components/schemas/WebhookEvent'
              required:
                - events
          required:
            - data
    HTTPValidationError:
      type: object
      description: FastAPI/Pydantic 请求参数校验错误。
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
      required:
        - detail
    SimpleResponse:
      type: object
      properties:
        code:
          oneOf:
            - type: string
            - type: integer
          description: 业务码。成功通常为 success 或 200。
        message:
          type: string
          description: 返回信息。
        tips:
          type:
            - string
            - 'null'
          description: 详细信息，默认为空。
    WebhookEvent:
      type: object
      properties:
        event_type:
          $ref: '#/components/schemas/WebhookEventType'
        name:
          type: string
        description:
          type: string
      required:
        - event_type
        - name
        - description
    ValidationErrorItem:
      type: object
      additionalProperties: true
      properties:
        type:
          type: string
          description: 校验错误类型。
        loc:
          type: array
          description: 错误字段在请求中的位置。
          items:
            oneOf:
              - type: string
              - type: integer
        msg:
          type: string
          description: 可读的错误说明。
        input:
          description: 导致校验失败的输入值。
        ctx:
          type: object
          additionalProperties: true
          description: 校验器提供的补充上下文。
        url:
          type: string
          format: uri
          description: Pydantic 错误说明链接。
      required:
        - type
        - loc
        - msg
    WebhookEventType:
      type: string
      enum:
        - doc_parse_completed
        - doc_extract_completed
        - collaboration_start
        - collaboration_success
        - collaboration_failed
        - collaboration_completed
        - collaboration_timeout
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: 生产环境 API Key，可在 ADP 平台的「我的 API」中查看。请确保 API Key 有效且属于生产环境。

````

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