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

# Webhook-Endpunkt ändern

> Ändert URL, Beschreibung, Ereignistypen und den Schalter `enabled`. Wieder einschalten setzt eine automatische Deaktivierung zurück.



## OpenAPI

````yaml /api-reference/openapi.json put /webhook-endpoints/{id}
openapi: 3.1.0
info:
  title: NETZFABRIK API
  description: >-
    REST-API der NETZFABRIK-Plattform für Domains, DNS, Cloud-Server, Webspaces,
    E-Mail-Dienste und Konto. Authentifizierung per JWT (Authorization: Bearer)
    oder API-Token (X-API-TOKEN).
  termsOfService: https://www.netzfabrik.com/tos
  contact:
    name: NETZFABRIK GmbH
    url: https://www.netzfabrik.com
    email: info@netzfabrik.com
  license:
    name: Proprietary
    url: https://www.netzfabrik.com/license
  version: 2026-11-21-4c0ba7f0
servers:
  - url: https://api.netzfabrik.com
security:
  - JWT: []
  - ApiToken: []
tags:
  - name: Login
  - name: Zwei-Faktor-Authentifizierung
  - name: Passkeys
  - name: Benutzer
  - name: Konten
  - name: Kunden
  - name: Verträge
  - name: Rechnungen
  - name: Support-Tickets
  - name: Domains
  - name: Domain-Labels
  - name: Domain-Bestellungen
  - name: Premium-Domains
  - name: Inhaberwechsel
  - name: Handles (Kontakte)
  - name: Handle-Verifizierung
  - name: TLD-Daten
  - name: Domain-Preise
  - name: Preislisten-Vorlagen
  - name: Preislisten-Versionen
  - name: Preis-Überschreibungen
  - name: Preisänderungen
  - name: Domain-Aktionen
  - name: Öffentliche Preislisten
  - name: Domain-Reseller
  - name: DNS-Zonen
  - name: DNS-Records
  - name: Weiterleitungen
  - name: Webhooks
  - name: Cloud-Server
  - name: Cloud-Server-Vorlagen
  - name: Regionen
  - name: SSH-Keys
  - name: ISO-Images
  - name: Anwendungen
  - name: Webspaces
  - name: Webspace-Tarife
  - name: Object Storage
  - name: E-Mail-Protection
  - name: E-Mail-Security
  - name: E-Mail-Archiv
  - name: Colocation
  - name: Racks
  - name: Stromzuführungen
  - name: Interconnections
  - name: VLANs
  - name: Traffic
  - name: DnsZoneTemplate
  - name: DnsZoneTemplateRun
  - name: DnsZoneTemplateSettings
paths:
  /webhook-endpoints/{id}:
    put:
      tags:
        - Webhooks
      summary: Webhook-Endpunkt ändern
      description: >-
        Ändert URL, Beschreibung, Ereignistypen und den Schalter `enabled`.
        Wieder einschalten setzt eine automatische Deaktivierung zurück.
      operationId: updateWebhookEndpoint
      parameters:
        - name: id
          in: path
          description: WebhookEndpoint identifier
          required: true
          deprecated: false
          schema:
            type: string
          style: simple
          explode: false
        - $ref: '#/components/parameters/CustomerId'
      requestBody:
        description: The updated WebhookEndpoint resource
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/WebhookEndpoint.WebhookEndpointInput-webhook-endpoint.write
            example:
              url: https://hooks.example.com/netz
              description: ERP-Anbindung
              eventTypes:
                - domain.registered
              enabled: true
        required: true
      responses:
        '200':
          description: WebhookEndpoint resource updated
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/WebhookEndpoint-webhook-endpoint.read_timestampable.created_at.read_timestampable.updated_at.read
          links: {}
        '400':
          description: Invalid input
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          links: {}
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          links: {}
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          links: {}
        '422':
          description: An error occurred
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ConstraintViolation'
            application/json:
              schema:
                $ref: '#/components/schemas/ConstraintViolation'
          links: {}
components:
  parameters:
    CustomerId:
      name: X-Customer-Id
      in: header
      required: false
      description: >-
        Optionaler Kundenkontext. Ohne Header arbeitet die Anfrage im
        Standard-Kunden des angemeldeten Benutzers. Mit der ID eines anderen
        Kunden handelt die Anfrage in dessen Kontext: Listen, Lese- und
        Schreibzugriffe beziehen sich dann auf diesen Kunden.


        Erlaubt sind der eigene Kunde, jeder Unterkunde im eigenen Teilbaum
        (Reseller handelt für seinen Endkunden) sowie Kunden, in denen der
        Benutzer selbst Mitglied ist. Übergeordnete oder fremde Kunden werden
        mit `403 Forbidden` abgewiesen, eine unbekannte ID ebenfalls.


        Die IDs der erreichbaren Kunden liefern `GET /user/customers` und `GET
        /customers/{id}/children`.
      schema:
        type: string
        example: 01JD4Q8W3N6Y2K5T7R9V0B1C2D
  schemas:
    WebhookEndpoint.WebhookEndpointInput-webhook-endpoint.write:
      type: object
      description: Ziel für ausgehende Ereignis-Webhooks eines Kunden (ARC-216).
      required:
        - url
      properties:
        url:
          maxLength: 2048
          default: ''
          example: https://hooks.example.com/netz
          type: string
        description:
          maxLength: 255
          example: ERP-Anbindung
          type:
            - string
            - 'null'
        eventTypes:
          minItems: 1
          example:
            - domain.registered
            - domain.renewed
          type: array
          items:
            type: string
        enabled:
          default: true
          type: boolean
    WebhookEndpoint-webhook-endpoint.read_timestampable.created_at.read_timestampable.updated_at.read:
      type: object
      description: Ziel für ausgehende Ereignis-Webhooks eines Kunden (ARC-216).
      properties:
        id:
          readOnly: true
          example: 01JD5M2Q8Y4X3W7V6T5S4R3Q2P
          type: string
        url:
          example: https://hooks.example.com/netz
          type: string
        description:
          example: ERP-Anbindung
          type:
            - string
            - 'null'
        eventTypes:
          example:
            - domain.registered
            - domain.renewed
          type: array
          items:
            type: string
        enabled:
          readOnly: true
          default: true
          type: boolean
        disabledReason:
          readOnly: true
          description: >-
            Grund der Deaktivierung: `customer` (von Hand) oder `failures`
            (automatisch).
          type:
            - string
            - 'null'
        disabledAt:
          readOnly: true
          type:
            - string
            - 'null'
          format: date-time
        previousSigningKeyExpiresAt:
          readOnly: true
          type:
            - string
            - 'null'
          format: date-time
        signingKeyRotatedAt:
          readOnly: true
          type:
            - string
            - 'null'
          format: date-time
        failingSince:
          readOnly: true
          description: >-
            Beginn der laufenden Fehlerserie (erster Fehlschlag seit dem letzten
            Erfolg).
          type:
            - string
            - 'null'
          format: date-time
        consecutiveFailures:
          readOnly: true
          default: 0
          type: integer
        lastSuccessAt:
          readOnly: true
          type:
            - string
            - 'null'
          format: date-time
        lastFailureAt:
          readOnly: true
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        customerId:
          readOnly: true
          type: string
    Error:
      type: object
      description: A representation of common errors.
      properties:
        title:
          readOnly: true
          description: A short, human-readable summary of the problem.
          type:
            - string
            - 'null'
        detail:
          readOnly: true
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type:
            - string
            - 'null'
        status:
          type:
            - integer
            - 'null'
          examples:
            - 404
          default: 400
        instance:
          readOnly: true
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem. It may or may not yield further information if
            dereferenced.
          type:
            - string
            - 'null'
        type:
          readOnly: true
          description: A URI reference that identifies the problem type
          type: string
    ConstraintViolation:
      type: object
      description: Unprocessable entity
      properties:
        status:
          default: 422
          type: integer
        violations:
          type: array
          items:
            type: object
            properties:
              propertyPath:
                type: string
                description: The property path of the violation
              message:
                type: string
                description: The message associated with the violation
              code:
                type: string
                description: The code of the violation
              hint:
                type: string
                description: An extra hint to understand the violation
              payload:
                type: object
                additionalProperties: true
                description: The serialized payload of the violation
            required:
              - propertyPath
              - message
        detail:
          readOnly: true
          type: string
        type:
          readOnly: true
          type: string
        title:
          readOnly: true
          type:
            - string
            - 'null'
        instance:
          readOnly: true
          type:
            - string
            - 'null'
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access-Token aus `POST /auth/login` (E-Mail und Passwort), gesendet als
        `Authorization: Bearer <token>`.


        Das Token ist zeitlich begrenzt gültig. Mit dem `refresh_token` aus
        derselben Antwort holt `POST /auth/token/refresh` ein neues Token-Paar,
        ohne das Passwort erneut zu senden; `POST /auth/token/invalidate` macht
        den Refresh-Token beim Abmelden ungültig.


        Ist für das Konto ein zweiter Faktor aktiv oder vorgeschrieben, liefert
        der Login statt des Token-Paars `mfaRequired: true` bzw.
        `mfaEnrollmentRequired: true` und ein kurzlebiges `preAuthToken`. Mit
        diesem Token (ebenfalls als Bearer) wird der zweite Faktor über `POST
        /auth/2fa/verify` bestätigt; erst danach gibt es das volle Token-Paar.
    ApiToken:
      type: apiKey
      in: header
      name: X-API-TOKEN
      description: >-
        Persönlicher API-Token für Skripte, CI/CD und
        Server-zu-Server-Integrationen, gesendet im Header `X-API-TOKEN:
        <token>`.


        Tokens werden im Kundenpanel unter **Einstellungen → Sicherheit**
        angelegt oder per `POST /user/api-tokens` mit einem gültigen JWT. Der
        Klartext erscheint nur einmal in der Antwort beim Anlegen. Ein Token
        handelt mit den Rechten des Benutzers, der ihn erstellt hat, kann ein
        Ablaufdatum haben und wird mit `DELETE /user/api-tokens/{id}` sofort
        widerrufen.

````

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