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

# Update a webhook endpoint

> Update an endpoint's URL, rotate its secret, change its audience, or edit its description. Provide at least one field.



## OpenAPI

````yaml /partner-api/openapi.json patch /webhook-config/{id}
openapi: 3.0.3
info:
  title: TruEnroll Partner API
  version: 1.0.0
  description: >-
    Submit academic documents and retrieve structured extraction, forensics, and
    translation results.
servers:
  - url: https://eval-api.trential.dev/partner/v1
    description: Sandbox
  - url: https://api.truenroll.com/partner/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: Cases
    description: Create and manage processing cases.
  - name: Results
    description: Fetch extraction, forensics, and translation results.
  - name: Webhooks
    description: Register endpoints that receive case events.
paths:
  /webhook-config/{id}:
    patch:
      tags:
        - Webhooks
      summary: Update a webhook endpoint
      description: >-
        Update an endpoint's URL, rotate its secret, change its audience, or
        edit its description. Provide at least one field.
      operationId: updateWebhookConfig
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Webhook config ID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWebhookConfigRequest'
            example:
              apiKey: whsec_rotated_secret_0987654321
              description: Rotated June 2026
      responses:
        '200':
          description: Updated webhook endpoint.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessResponse'
                  - properties:
                      data:
                        $ref: '#/components/schemas/WebhookConfig'
        '400':
          description: Invalid request body, or no fields provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Webhook config not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Another active webhook config already uses the target endpoint URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    UpdateWebhookConfigRequest:
      type: object
      minProperties: 1
      description: Provide at least one field to change.
      properties:
        endpoint:
          type: string
          format: uri
          description: New HTTPS URL to deliver events to.
        apiKey:
          type: string
          minLength: 20
          description: Rotate the shared secret (at least 20 characters).
        audience:
          type: string
          enum:
            - partner
            - internal
        description:
          type: string
    SuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
        meta:
          type: object
          description: >-
            Optional metadata (e.g. pagination). Empty object when not
            applicable.
        data: {}
      required:
        - success
        - message
        - meta
        - data
    WebhookConfig:
      type: object
      properties:
        id:
          type: string
        endpoint:
          type: string
          format: uri
        audience:
          type: string
          enum:
            - partner
            - internal
        description:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - endpoint
        - audience
        - createdAt
        - updatedAt
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
      required:
        - statusCode
        - message
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: 'Partner API key. Also accepted as `Authorization: Bearer <key>`.'

````