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

# Update Webhook

> Partial update — pass only the fields you want to change. Setting `enabled: false`
immediately stops events from fanning out to this webhook (existing in-flight
deliveries finish their attempts).




## OpenAPI

````yaml /openapi.yaml patch /v1/webhooks/{id}
openapi: 3.1.0
info:
  title: AnchorBrowser API
  version: 1.0.0
  description: APIs to manage all browser-related actions and configuration.
servers:
  - url: https://api.anchorbrowser.io
    description: API server
security: []
paths:
  /v1/webhooks/{id}:
    patch:
      tags:
        - Webhooks
      summary: Update Webhook
      description: >
        Partial update — pass only the fields you want to change. Setting
        `enabled: false`

        immediately stops events from fanning out to this webhook (existing
        in-flight

        deliveries finish their attempts).
      operationId: updateWebhook
      parameters:
        - name: id
          in: path
          required: true
          description: Webhook id.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookUpdateRequest'
            examples:
              changeUrl:
                summary: Move to a new endpoint URL
                value:
                  url: https://new-host.example.com/anchor/webhooks
              addEvents:
                summary: Add session events to subscriptions
                value:
                  subscribed_events:
                    - task.completed
                    - task.failed
                    - session.completed
                    - session.failed
              disable:
                summary: Pause delivery without losing config
                value:
                  enabled: false
      responses:
        '200':
          description: Webhook updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookPublic'
        '400':
          description: Validation error (URL constraints same as create).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlatErrorResponse'
        '404':
          description: Webhook not found in this project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlatErrorResponse'
        '500':
          description: Failed to update webhook.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlatErrorResponse'
      security:
        - api_key_header: []
components:
  schemas:
    WebhookUpdateRequest:
      type: object
      description: Partial update — only the fields you include are changed.
      properties:
        url:
          type: string
          format: uri
          minLength: 1
          maxLength: 2048
        description:
          type: string
          nullable: true
          maxLength: 256
        subscribed_events:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/WebhookEventType'
        enabled:
          type: boolean
    WebhookPublic:
      type: object
      description: >-
        A registered webhook subscription. The signing secret is NEVER returned
        by GET/list endpoints.
      required:
        - id
        - project_id
        - url
        - description
        - subscribed_events
        - enabled
        - created_at
        - updated_at
      properties:
        id:
          type: string
          description: Webhook id. Use as the path parameter on subsequent calls.
          example: wh_01HXJ4MZ7K9P3Q6R8S2T4V5W7Y
        project_id:
          type: string
          format: uuid
          description: The project (team) the webhook belongs to.
          example: 5d2c31f6-ab7e-481a-b6fd-8b4a96a4e197
        url:
          type: string
          format: uri
          description: HTTPS URL Anchor will POST events to.
          example: https://your-app.example.com/anchor/webhooks
        description:
          type: string
          nullable: true
          maxLength: 256
          description: Optional human-readable description.
          example: Production task notifications
        subscribed_events:
          type: array
          description: Event types this webhook is currently subscribed to.
          items:
            $ref: '#/components/schemas/WebhookEventType'
        enabled:
          type: boolean
          description: When `false`, no events fan out to this webhook.
          example: true
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    FlatErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
        code:
          type: integer
          description: HTTP status code.
      required:
        - error
    WebhookEventType:
      type: string
      description: |
        Catalog of webhook event types Anchor can deliver. Adding a new event
        type is a coordinated change between session-manager (publisher),
        webhook-dispatcher (consumer), and the dashboard.
      enum:
        - task.completed
        - task.failed
        - task.cancelled
        - task.healed
        - session.completed
        - session.failed
        - session.recording.ready
        - batch.completed
        - batch.failed
        - intervention.requested
        - intervention.resolved
        - identity.authenticated
        - identity.authentication_failed
  securitySchemes:
    api_key_header:
      type: apiKey
      in: header
      name: anchor-api-key
      description: API key passed in the header

````