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

# Update Webhook

> Update a webhook endpoint (URL, document categories filter, enabled, description).



## OpenAPI

````yaml PATCH /api/v2/webhooks/{id}
openapi: 3.1.0
info:
  title: Captide REST API
  description: >-
    API for accessing financial disclosures and AI-powered financial document
    analysis.
  version: 0.3.14
servers:
  - url: https://rest-api.captide.co
    description: Prod server
security: []
paths:
  /api/v2/webhooks/{id}:
    patch:
      tags:
        - Webhooks
      summary: Update webhook
      description: >-
        Update a webhook endpoint (URL, document categories filter, enabled,
        description).
      operationId: update_webhook_api_v2_webhooks__id__patch
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Webhook endpoint ID
            title: Id
          description: Webhook endpoint ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookUpdate'
      responses:
        '200':
          description: The updated webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookResponse'
              example:
                id: 3f2c8d1e-5b7a-4c9e-8f10-2a6b4d9e7c51
                url: https://example.com/captide/webhook
                documentCategories:
                  - earnings-release
                  - earnings-call-transcript
                enabled: true
                description: Earnings watchlist
                createdAt: '2026-11-03T17:40:12.481930+00:00'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              examples:
                missing_key:
                  summary: Missing API key
                  value:
                    detail: Missing API key
                invalid_key:
                  summary: Invalid or expired API key
                  value:
                    detail: Invalid or expired API key
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Your organization doesn't have access to this endpoint
          content:
            application/json:
              examples:
                forbidden:
                  summary: Access to this endpoint is not allowed for your organization
                  value:
                    detail: >-
                      Access to this endpoint is not allowed for your
                      organization
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              examples:
                not_found:
                  summary: Webhook not found
                  value:
                    detail: Webhook not found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: >-
            Validation error: a parameter or body field is missing, has the
            wrong type or is out of range
          content:
            application/json:
              example:
                detail:
                  - type: uuid_parsing
                    loc:
                      - path
                      - id
                    msg: >-
                      Input should be a valid UUID, invalid length: expected
                      length 32 for simple format, found 3
                    input: abc
                    ctx:
                      error: >-
                        invalid length: expected length 32 for simple format,
                        found 3
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              examples:
                rate_limited:
                  summary: 'Rate limit exceeded: 100 requests per minute'
                  value:
                    detail: 'Rate limit exceeded: 100 requests per minute'
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              examples:
                database_error:
                  summary: Database error occurred
                  value:
                    detail: Database error occurred
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - APIKeyHeader: []
components:
  schemas:
    WebhookUpdate:
      properties:
        url:
          anyOf:
            - type: string
              maxLength: 2083
              minLength: 1
              format: uri
            - type: 'null'
          title: Url
          description: New URL for the webhook
        documentCategories:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Documentcategories
          description: >-
            Only send webhooks for these document category codes. Empty list or
            null = all.
        enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Enabled
          description: Enable or disable the webhook
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Optional description
      type: object
      title: WebhookUpdate
      description: Payload to update a webhook endpoint.
    WebhookResponse:
      properties:
        id:
          type: string
          title: Id
          description: Webhook endpoint ID
        url:
          type: string
          title: Url
          description: URL that receives the webhook payload
        documentCategories:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Documentcategories
          description: Document categories this webhook is filtered to; null = all
        enabled:
          type: boolean
          title: Enabled
          description: Whether the webhook is active
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Optional description
        createdAt:
          type: string
          title: Createdat
          description: ISO 8601 creation time
      type: object
      required:
        - id
        - url
        - enabled
        - createdAt
      title: WebhookResponse
      description: Webhook endpoint as returned by the API.
    ErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
      type: object
      required:
        - detail
      title: ErrorResponse
      description: Standard error response model for all API endpoints.
    ValidationErrorResponse:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
          type: array
          title: Detail
      type: object
      required:
        - detail
      title: ValidationErrorResponse
      description: '422 body: every invalid field of the request.'
    ValidationErrorItem:
      properties:
        type:
          type: string
          title: Type
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Loc
        msg:
          type: string
          title: Msg
        input:
          anyOf:
            - {}
            - type: 'null'
          title: Input
        ctx:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Ctx
      type: object
      required:
        - type
        - loc
        - msg
      title: ValidationErrorItem
      description: One invalid field, as FastAPI reports it.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

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