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

# Update webhook configuration

> Update a webhook configuration.

Updates only the fields you provide. The signing secret cannot be updated
via this endpoint - use the rotate endpoint instead.



## OpenAPI

````yaml openapi.json patch /v1/webhooks/{webhook_config_id}
openapi: 3.1.0
info:
  title: DocIntell API
  description: >-

    # DocIntell API


    **Turn Documents into Data. Keep the Source Safe.**


    Financial document intelligence platform that turns PDFs into queryable data
    while keeping source files secure and compliant.


    ## Features


    - **Document Ingestion**: Upload PDFs with SEC 17a-4 compliant immutable
    storage

    - **Schema Projection**: Query extracted data with custom schemas (not data
    dumps!)

    - **Multi-Schema Support**: Same document, multiple query patterns

    - **Webhook Delivery**: Async notifications on job completion

    - **Row-Level Security**: Multi-tenant isolation built-in


    ## Authentication


    All API endpoints (except `/health`, `/`, `/docs`, and `/redoc`) require API
    key authentication.


    Include your API key in the `Authorization` header:


    ```

    Authorization: Bearer dk_live_<your_key>

    ```


    Test keys start with `dk_test_`, production keys with `dk_live_`.


    ## Rate Limiting


    Per-tenant rate limits:

    - **Document ingestion**: 100 documents/hour

    - **Projection queries**: 1,000 requests/hour

    - **Schema operations**: 10 creates/hour


    Rate limit info is returned in response headers:

    - `X-RateLimit-Limit`: Maximum requests allowed

    - `X-RateLimit-Remaining`: Remaining requests in window

    - `X-RateLimit-Reset`: Unix timestamp when limit resets


    ## Error Handling


    All errors follow RFC 7807 Problem Details format:


    ```json

    {
      "error": "error_code",
      "message": "Human-readable description",
      "details": {}
    }

    ```


    Common error codes:

    - `unauthorized` (401): Missing or invalid API key

    - `rate_limit_exceeded` (429): Too many requests

    - `invalid_file_type` (400): Only PDFs supported

    - `file_too_large` (413): File exceeds size limit (default 100MB,
    configurable via MAX_UPLOAD_SIZE_MB)

    - `job_not_found` (404): Job ID doesn't exist or doesn't belong to tenant


    ## Getting Started


    1. Obtain API key from dashboard

    2. Upload PDF: `POST /v1/documents`

    3. Poll status: `GET /v1/documents/{document_id}/status`

    4. Query results: `POST /v1/documents/{document_id}/project`


    Full documentation: [https://docs.docintel.com](https://docs.docintel.com)
        
  contact:
    name: DocIntell Support
    url: https://docintel.com/support
    email: support@docintel.com
  license:
    name: Proprietary
    url: https://docintel.com/terms
  version: 0.1.0
servers:
  - url: http://localhost:8000
    description: Local development
  - url: https://api.docintell.com
    description: Production API
  - url: https://api-staging.docintell.com
    description: Staging environment
security:
  - bearerAuth: []
tags:
  - name: health
    description: Health check operations. Verify service and dependency connectivity.
    x-mint-tag-group: System
  - name: api_keys
    description: API key management operations. Create, list, and revoke API keys.
    x-mint-tag-group: Management
  - name: documents
    description: Document ingestion operations. Upload PDFs for extraction.
    x-mint-tag-group: Core
  - name: jobs
    description: >-
      Job status and query operations. Check extraction status and query
      results.
    x-mint-tag-group: Core
  - name: document-types
    description: >-
      Document type schemas. List and retrieve extraction schema definitions for
      financial document types.
  - name: webhooks
    description: >-
      Webhook configuration management. Create, update, and manage webhook
      endpoints for job completion notifications.
    x-mint-tag-group: Integrations
  - name: stats
    description: Analytics and metrics endpoints. Get document, job, and schema statistics.
  - name: views
    description: >-
      View management for consumption layer. Define field subsets for querying
      extraction data.
paths:
  /v1/webhooks/{webhook_config_id}:
    patch:
      tags:
        - webhooks
      summary: Update webhook configuration
      description: >-
        Update a webhook configuration.


        Updates only the fields you provide. The signing secret cannot be
        updated

        via this endpoint - use the rotate endpoint instead.
      operationId: update_webhook_config_v1_webhooks__webhook_config_id__patch
      parameters:
        - name: webhook_config_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Webhook configuration ID
            title: Webhook Config Id
          description: Webhook configuration ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWebhookConfigRequest'
      responses:
        '200':
          description: Updated webhook configuration (without secret)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookConfigResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    UpdateWebhookConfigRequest:
      properties:
        url:
          anyOf:
            - type: string
              maxLength: 2048
              minLength: 1
            - type: 'null'
          title: Url
          description: HTTPS webhook endpoint URL
        events:
          anyOf:
            - items:
                type: string
                enum:
                  - document.uploaded
                  - document.processing.completed
                  - document.processing.failed
              type: array
            - type: 'null'
          title: Events
          description: List of event types to subscribe to
        is_active:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Active
          description: Whether the webhook is active
        retry_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Retry Enabled
          description: Whether to retry failed deliveries
        max_retries:
          anyOf:
            - type: integer
              maximum: 10
              minimum: 0
            - type: 'null'
          title: Max Retries
          description: Maximum retry attempts (0-10)
      type: object
      title: UpdateWebhookConfigRequest
      description: >-
        Request schema for updating a webhook configuration (PATCH
        /v1/webhooks/{id}).


        All fields are optional. Only provided fields will be updated.


        Attributes:
            url: HTTPS webhook endpoint URL
            events: List of event types to subscribe to
            is_active: Whether the webhook is active
            retry_enabled: Whether to retry failed deliveries
            max_retries: Maximum retry attempts

        Available Events:
            - document.uploaded: Document successfully uploaded and queued
            - document.processing.completed: Extraction completed successfully
            - document.processing.failed: Extraction failed with error
      examples:
        - url: https://customer.com/webhooks/v2/docintel
        - is_active: false
        - events:
            - document.processing.completed
    WebhookConfigResponse:
      properties:
        webhook_config_id:
          type: string
          format: uuid
          title: Webhook Config Id
          description: Unique webhook configuration identifier
        url:
          type: string
          title: Url
          description: HTTPS webhook endpoint URL
        events:
          items:
            type: string
          type: array
          title: Events
          description: List of event types subscribed to
        is_active:
          type: boolean
          title: Is Active
          description: Whether the webhook is active
        retry_enabled:
          type: boolean
          title: Retry Enabled
          description: Whether to retry failed deliveries
        max_retries:
          type: integer
          title: Max Retries
          description: Maximum retry attempts
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Configuration creation timestamp (ISO 8601)
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Last modification timestamp (ISO 8601)
      type: object
      required:
        - webhook_config_id
        - url
        - events
        - is_active
        - retry_enabled
        - max_retries
        - created_at
        - updated_at
      title: WebhookConfigResponse
      description: |-
        Webhook configuration response (without signing secret).

        Used for list operations and updates where the secret is not returned.

        Available Events:
            - document.uploaded: Document successfully uploaded and queued
            - document.processing.completed: Extraction completed successfully
            - document.processing.failed: Extraction failed with error
      examples:
        - created_at: '2024-01-15T10:30:00Z'
          events:
            - document.processing.completed
            - document.processing.failed
          is_active: true
          max_retries: 5
          retry_enabled: true
          updated_at: '2024-01-15T10:30:00Z'
          url: https://customer.com/webhooks/docintel
          webhook_config_id: 550e8400-e29b-41d4-a716-446655440000
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'API Key authentication. Format: dk_test_<key> or dk_live_<key>'

````