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

# Update webhook

Any mutable field: `name`, `description`, `webhook_url`, `headers`, `payload_format`, `status`. Setting `status: "disabled"` retains the webhook but stops deliveries.


## OpenAPI

````yaml patch /v2/webhooks/{webhook_id}
openapi: 3.1.0
info:
  title: Partner Service
  version: 0.3.24
servers:
  - url: https://api.explorium.ai
    description: AgentSource Server
security: []
paths:
  /v2/webhooks/{webhook_id}:
    patch:
      tags:
        - V2Webhooks
      summary: Patch
      operationId: patch
      parameters:
        - required: true
          schema:
            type: string
            title: Webhook Id
          name: webhook_id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookPatchRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
        - APIKeyHeader: []
components:
  schemas:
    WebhookPatchRequest:
      properties:
        headers:
          items:
            type: string
          type: array
          title: Headers
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        webhook_url:
          type: string
          maxLength: 65536
          minLength: 1
          format: uri
          title: Webhook Url
        payload_format:
          $ref: '#/components/schemas/PayloadFormat'
        status:
          $ref: '#/components/schemas/WebhookStatus'
      additionalProperties: false
      type: object
      title: WebhookPatchRequest
    WebhookResponse:
      properties:
        webhook_id:
          type: string
          title: Webhook Id
        scope:
          $ref: '#/components/schemas/WebhookScope'
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        webhook_url:
          type: string
          title: Webhook Url
        headers:
          items:
            type: string
          type: array
          title: Headers
        payload_format:
          allOf:
            - $ref: '#/components/schemas/PayloadFormat'
        status:
          $ref: '#/components/schemas/WebhookStatus'
        created_at:
          type: string
          format: date-time
          title: Created At
        last_modified_time:
          type: string
          format: date-time
          title: Last Modified Time
        legacy:
          type: boolean
          title: Legacy
        response_context:
          $ref: '#/components/schemas/ResponseContext'
      type: object
      required:
        - webhook_id
        - scope
        - name
        - webhook_url
        - status
        - created_at
        - last_modified_time
        - response_context
      title: WebhookResponse
      description: This is base response model for all responses in partner service.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PayloadFormat:
      type: string
      enum:
        - json
        - stringified_json
      title: PayloadFormat
      description: An enumeration.
    WebhookStatus:
      type: string
      enum:
        - active
        - disabled
      title: WebhookStatus
      description: An enumeration.
    WebhookScope:
      properties:
        type:
          $ref: '#/components/schemas/WebhookScopeType'
        id:
          type: string
          title: Id
      type: object
      required:
        - type
        - id
      title: WebhookScope
    ResponseContext:
      properties:
        correlation_id:
          type: string
          title: Correlation Id
        request_status:
          $ref: '#/components/schemas/RequestStatus'
        time_took_in_seconds:
          type: number
          title: Time Took In Seconds
      type: object
      required:
        - correlation_id
        - request_status
        - time_took_in_seconds
      title: ResponseContext
    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
    WebhookScopeType:
      type: string
      enum:
        - tenant
        - organization
        - partner
      title: WebhookScopeType
      description: An enumeration.
    RequestStatus:
      type: string
      enum:
        - success
        - miss
        - failure
      title: RequestStatus
      description: >-
        The `RequestStatus` class is an enumeration that defines the possible
        statuses of a request.


        This enum is used to indicate whether a request was successful, missed,
        or failed. It ensures

        consistent handling of request statuses across the application.


        Attributes:
            SUCCESS: Indicates that the request was successfully processed.
            MISS: Indicates that the request did not find any matching data.
            FAILURE: Indicates that the request encountered an error or failure.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: api_key

````