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

# Update Webhook Config

> Update a webhook configuration. You can update the URL, subscribed statuses, or active state. The secret cannot be changed (use rotate-secret endpoint in future versions).



## OpenAPI

````yaml PATCH /v1/webhooks/configs/:id
openapi: 3.1.0
info:
  title: Beltic Document API
  version: 1.0.0
  description: >-
    # The Beltic Document API provides a comprehensive solution for document
    processing with AI-powered data extraction and fraud detection capabilities.


    ## Key Features


    - **Template-Based Processing**: Create reusable document templates with
    predefined schemas and processing configurations

    - **Ad-Hoc Processing**: Process documents without templates using custom
    configurations

    - **AI Data Extraction**: Intelligent document data extraction powered by AI

    - **Fraud Detection**: Document authenticity verification and fraud analysis

    - **Secure File Handling**: Pre-signed URLs for secure file uploads


    ## Workflow


    1. **Create a Document Template**: Define a template with extraction schema
    and fraud detection settings

    2. **Create a Document**: Initialize a document with either a template
    reference or ad-hoc configuration

    3. **Upload File**: Use the pre-signed URL to upload your document file

    4. **Automatic Processing**: Once uploaded, the document is automatically
    processed with extraction and fraud detection

    5. **Retrieve Results**: Fetch the document to access extracted data and
    fraud analysis results


    ## Authentication


    All endpoints require authentication. Include your API key in the
    `X-Api-Key` header:

    ```

    X-Api-Key: YOUR_API_KEY

    ```


    ## Response Format


    All responses follow the JSON:API specification for consistent data
    structures.
  contact:
    name: Beltic API Support
    email: engineering@beltic.com
servers:
  - url: https://api.beltic.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Document Templates
    description: >-
      Manage document templates for repeatable processing workflows. Templates
      define the structure and processing configuration for documents including
      JSON schemas for data extraction and fraud detection settings.
  - name: Documents
    description: >-
      Create and manage documents for processing. Documents can be associated
      with a template for standardized processing, or configured ad-hoc with
      custom settings. The workflow involves creating a document record,
      uploading the file via pre-signed URL, and automatically processing the
      document with AI-powered extraction and fraud detection. Documents track
      their processing status and store extracted data and fraud analysis
      results.
  - name: Webhooks
    description: >-
      Configure webhook endpoints to receive real-time notifications when
      document status changes. Webhooks support automatic retries with
      exponential backoff and provide options for manual resend and DLQ
      reprocessing.
externalDocs:
  description: Beltic Platform Documentation
  url: https://docs.beltic.com
paths:
  /v1/webhooks/configs/:id:
    patch:
      tags:
        - Webhooks
      summary: Update webhook config
      description: >-
        Update a webhook configuration. You can update the URL, subscribed
        statuses, or active state. The secret cannot be changed (use
        rotate-secret endpoint in future versions).
      parameters:
        - schema:
            type: string
            format: uuid
            description: Webhook config ID
            example: 123e4567-e89b-12d3-a456-426614174000
          required: true
          description: Webhook config ID
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - webhook_config
                    id:
                      type: string
                      format: uuid
                    attributes:
                      type: object
                      properties:
                        url:
                          type: string
                          format: uri
                          description: Updated webhook URL
                          example: https://example.com/webhooks/documents/v2
                        subscribed_statuses:
                          type: array
                          items:
                            type: string
                            enum:
                              - pending
                              - submitted
                              - processing
                              - processed
                              - failed
                          minItems: 1
                          description: Updated subscribed statuses
                          example:
                            - pending
                            - processed
                            - failed
                        is_active:
                          type: boolean
                          description: Enable or disable the webhook config
                          example: false
                  required:
                    - type
                    - id
                    - attributes
              required:
                - data
      responses:
        '200':
          description: Webhook config updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - webhook_config
                      id:
                        type: string
                        format: uuid
                      attributes:
                        type: object
                        properties:
                          resource_type:
                            type: string
                            enum:
                              - document
                            description: The resource type this webhook config is for
                            example: document
                          url:
                            type: string
                            format: uri
                            description: >-
                              HTTPS endpoint URL to receive webhook
                              notifications
                            example: https://example.com/webhooks/documents
                          subscribed_statuses:
                            type: array
                            items:
                              type: string
                              enum:
                                - pending
                                - submitted
                                - processing
                                - processed
                                - failed
                            minItems: 1
                            description: >-
                              Document statuses that trigger webhook
                              notifications
                            example:
                              - processed
                              - failed
                          secret_prefix:
                            type: string
                            description: >-
                              First few characters of the webhook secret (for
                              identification)
                            example: abc12...
                          is_active:
                            type: boolean
                            description: Whether this webhook config is active
                            example: true
                          created_at:
                            type: string
                            format: date-time
                            description: Creation timestamp
                            example: '2026-01-16T10:00:00.000Z'
                          updated_at:
                            type: string
                            format: date-time
                            description: Last update timestamp
                            example: '2026-01-16T10:00:00.000Z'
                        required:
                          - resource_type
                          - url
                          - subscribed_statuses
                    required:
                      - type
                      - id
                      - attributes
                required:
                  - data
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        status:
                          type: string
                        title:
                          type: string
                        detail:
                          type: string
                      required:
                        - status
                        - title
                        - detail
                required:
                  - errors
        '404':
          description: Webhook config not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        status:
                          type: string
                        title:
                          type: string
                        detail:
                          type: string
                      required:
                        - status
                        - title
                        - detail
                required:
                  - errors
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: |-
        API key for authentication.
        Access https://console.beltic.com/ to obtain your API key.

````