> ## 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.

# Update Webhook

> Update the callback URL, event types, or application scope. Omitting `app_id` leaves the application scope unchanged. Passing `null` or an empty array explicitly clears the scope and subscribes to all applications under the current account.

The backend accepts a request containing only `webhook_id` as a no-op. The public contract requires at least one field to update. Use only a caller-controlled, public HTTPS callback URL.




## OpenAPI

````yaml en/api-reference/adp-api.yaml POST /open/agentic_doc_processor/{tenant_name}/v1/webhook/update
openapi: 3.1.0
info:
  title: ADP API
  version: 1.0.0
  description: >-
    Laiye ADP OpenAPI reference for document extraction, recognition, and
    conversion; extraction application management; webhooks; human
    collaboration; credit usage; workflow discovery, runs, exports, and file
    management.
  license:
    name: MIT
    identifier: MIT
servers:
  - url: https://adp-global.laiye.com
    description: ADP global production endpoint
security: []
tags:
  - name: Document extraction
    description: Extract structured fields from uploaded documents.
  - name: Document recognition
    description: Recognize text, layout blocks, and positions from uploaded documents.
  - name: Document conversion
    description: >-
      Convert PDFs, Office documents, OFD files, and images into page images or
      native spreadsheet structures.
  - name: Application management
    description: >-
      Create, update, delete, and query extraction applications and
      configurations.
  - name: Webhook
    description: List system events and manage event callbacks.
  - name: Account
    description: Query credit usage.
  - name: Workflow
    description: >-
      List business workflow templates, run workflow applications, and query run
      results.
  - name: Workflow files
    description: Upload and manage files used by workflow applications.
  - name: Human collaboration
    description: >-
      Configure review triggers, query collaboration tasks, and submit human
      corrections.
paths:
  /open/agentic_doc_processor/{tenant_name}/v1/webhook/update:
    post:
      tags:
        - Webhook
      summary: Update Webhook
      description: >
        Update the callback URL, event types, or application scope. Omitting
        `app_id` leaves the application scope unchanged. Passing `null` or an
        empty array explicitly clears the scope and subscribes to all
        applications under the current account.


        The backend accepts a request containing only `webhook_id` as a no-op.
        The public contract requires at least one field to update. Use only a
        caller-controlled, public HTTPS callback URL.
      operationId: updateWebhook
      parameters:
        - $ref: '#/components/parameters/TenantName'
      requestBody:
        $ref: '#/components/requestBodies/WebhookUpdateRequest'
      responses:
        '200':
          $ref: '#/components/responses/WebhookMutationResponse'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    TenantName:
      name: tenant_name
      in: path
      required: true
      description: 'Tenant name. Default: laiye.'
      schema:
        type: string
        default: laiye
  requestBodies:
    WebhookUpdateRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WebhookUpdateRequest'
          example:
            webhook_id: webhook_abc123
            event_types:
              - doc_parse_completed
              - doc_extract_completed
  responses:
    WebhookMutationResponse:
      description: Webhook creation or update result.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/WebhookMutationResponse'
    ValidationError:
      description: Validation error.
      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:
    WebhookUpdateRequest:
      type: object
      additionalProperties: false
      anyOf:
        - required:
            - webhook_url
        - required:
            - event_types
        - required:
            - app_id
      properties:
        webhook_id:
          type: string
          minLength: 1
        webhook_url:
          type: string
          format: uri
          pattern: ^https://
          maxLength: 512
          description: New public HTTPS callback URL.
        event_types:
          type: array
          minItems: 1
          uniqueItems: true
          items:
            $ref: '#/components/schemas/WebhookEventType'
        app_id:
          type:
            - array
            - 'null'
          uniqueItems: true
          description: >-
            Passing `null` or an empty array explicitly clears the application
            scope; omitting it leaves the scope unchanged.
          items:
            type: string
            minLength: 1
      required:
        - webhook_id
    WebhookMutationResponse:
      allOf:
        - $ref: '#/components/schemas/SimpleResponse'
        - type: object
          properties:
            data:
              oneOf:
                - type: object
                  properties:
                    webhook_id:
                      type: string
                  required:
                    - webhook_id
                - type: 'null'
    HTTPValidationError:
      type: object
      description: FastAPI/Pydantic request validation error.
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
      required:
        - detail
    WebhookEventType:
      type: string
      enum:
        - doc_parse_completed
        - doc_extract_completed
        - collaboration_start
        - collaboration_success
        - collaboration_failed
        - collaboration_completed
        - collaboration_timeout
    SimpleResponse:
      type: object
      properties:
        code:
          oneOf:
            - type: string
            - type: integer
          description: Business code. A successful response is usually success or 200.
        message:
          type: string
          description: Response message.
        tips:
          type:
            - string
            - 'null'
          description: Details. Defaults to null.
    ValidationErrorItem:
      type: object
      additionalProperties: true
      properties:
        type:
          type: string
          description: Validation error type.
        loc:
          type: array
          description: Location of the invalid field in the request.
          items:
            oneOf:
              - type: string
              - type: integer
        msg:
          type: string
          description: Human-readable validation error message.
        input:
          description: Input value that failed validation.
        ctx:
          type: object
          additionalProperties: true
          description: Additional context supplied by the validator.
        url:
          type: string
          format: uri
          description: Link to the Pydantic error documentation.
      required:
        - type
        - loc
        - msg
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        Production API Key. You can find it under My API in the ADP platform.
        Make sure the API Key is active and belongs to the production
        environment.

````

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