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

# Update Webhook Endpoint

> Change the events an endpoint receives, or switch it off and on again. A disabled endpoint keeps its URL,
secret and delivery log.



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/webhook_endpoints/{endpoint_id}
openapi: 3.1.0
info:
  title: Kite Platform API
  description: >-
    Public API for Kite. Authenticate with `Authorization: Bearer kite_...`, and
    send `Kite-Version: 2026-09-27` to pin the dated contract your code was
    written against (without it you get 2026-09-27). Every response carries the
    version that served it.
  version: '2026-09-27'
servers:
  - url: https://api.kiteml.com
    description: Kite Platform API
security:
  - bearerAuth: []
tags:
  - name: Augmentations
    description: Generate new episodes from a LeRobot dataset.
  - name: Training runs
    description: Fine-tune a policy on a dataset, one run per policy.
  - name: Twins
    description: Rebuild a robot episode as an interactable MuJoCo scene (private beta).
  - name: RL runs
    description: >-
      Train a robot policy in simulation from a task spec; get the policy, its
      scene and a verdict.
  - name: Evaluations
    description: >-
      Preview. Run a policy across simulated scenarios; get its success rate,
      failure reasons and edge cases.
  - name: Scenarios
    description: >-
      Preview. The scenarios an evaluation runs, and your own, composed from
      robots, tasks and objects.
  - name: Objects and environments
    description: Preview. Bring your own objects and environments to your scenarios.
  - name: Sim runs
    description: >-
      Preview. Run a Kite SDK spec on Kite's machines: episodes, evaluators and
      a scorecard (enabled per account).
  - name: Catalog
    description: Policies, hardware tiers, and dataset inspection.
  - name: Operations
    description: Poll any run by its id.
  - name: Webhooks
    description: Endpoints that receive events, and the event log.
  - name: API keys
    description: The key making the request.
  - name: Usage
    description: Token usage and credit balance.
  - name: Requests
    description: >-
      The request log: every call of the last 30 days, who made it and how it
      ended.
  - name: Status
    description: Whether Kite is up, part by part. Needs no key.
paths:
  /v1/webhook_endpoints/{endpoint_id}:
    patch:
      tags:
        - Webhooks
      summary: Update Webhook Endpoint
      description: >-
        Change the events an endpoint receives, or switch it off and on again. A
        disabled endpoint keeps its URL,

        secret and delivery log.
      operationId: update_webhook_endpoint_v1_webhook_endpoints__endpoint_id__patch
      parameters:
        - name: endpoint_id
          in: path
          required: true
          schema:
            type: string
            title: Endpoint Id
        - $ref: '#/components/parameters/KiteVersion'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookEndpointUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpoint'
              example:
                created_at: '2026-09-27T01:00:00Z'
                enabled_events:
                  - augmentation.*
                id: whk_01K62QZ8V4X9C3N7M5T2R8W6HB
                last_delivery:
                  attempts: 2
                  created_at: '2026-09-27T02:00:00Z'
                  endpoint_id: whk_01K62QZ8V4X9C3N7M5T2R8W6HB
                  event_id: evt_01K62QZ8V4X9C3N7M5T2R8W6HC
                  event_type: augmentation.completed
                  id: dlv_9f1c2b7e4a5d4e8f9a0b1c2d3e4f5a6b
                  last_response_status: 503
                  next_attempt_at: '2026-09-27T02:06:00Z'
                  object: webhook_delivery
                  status: pending
                object: webhook_endpoint
                status: active
                url: https://example.com/kite
        '400':
          description: >-
            Invalid request (`parameter_invalid`, `unsupported_version`, ...);
            `param` names the field
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Missing or invalid API key (`unauthenticated`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: >-
            The key lacks a scope this route needs (`missing_scope`), or the
            feature is not enabled for the account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: >-
            No such resource (`resource_not_found`); another account's ids
            answer the same
        '429':
          description: >-
            Rate or concurrency limited (`rate_limit_exceeded`,
            `concurrency_limit_exceeded`, `capacity_exceeded`); honor
            `Retry-After`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
components:
  parameters:
    KiteVersion:
      name: Kite-Version
      in: header
      required: false
      description: >-
        The dated contract your code was written against. Without it you get
        2026-09-27; every response says which version served it.
      schema:
        type: string
        enum:
          - '2026-09-27'
        default: '2026-09-27'
  schemas:
    WebhookEndpointUpdate:
      properties:
        enabled_events:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Enabled Events
          description: >-
            Replaces the event types it receives (supports 'augmentation.*');
            null or [] for all
        status:
          anyOf:
            - type: string
              enum:
                - active
                - disabled
            - type: 'null'
          title: Status
          description: >-
            `disabled`: Kite sends it nothing until you set `active` again.
            Events in between are not sent later (read them from GET
            /v1/events), and its pending retries fail
      type: object
      title: WebhookEndpointUpdate
      description: Only the fields you send change.
    WebhookEndpoint:
      properties:
        id:
          type: string
          title: Id
          description: '`whk_` + a time-ordered ULID'
        object:
          type: string
          enum:
            - webhook_endpoint
          const: webhook_endpoint
          title: Object
          default: webhook_endpoint
        url:
          type: string
          title: Url
        enabled_events:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Enabled Events
          description: The event types it receives; null means all
        status:
          type: string
          title: Status
          description: '`active` or `disabled`'
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
        last_delivery:
          anyOf:
            - $ref: '#/components/schemas/WebhookDelivery'
            - type: 'null'
          description: Its newest delivery; null before the first
      type: object
      required:
        - id
        - url
        - status
      title: WebhookEndpoint
      description: A registered webhook receiver.
      examples:
        - created_at: '2026-09-27T01:00:00Z'
          enabled_events:
            - augmentation.*
          id: whk_01K62QZ8V4X9C3N7M5T2R8W6HB
          last_delivery:
            attempts: 2
            created_at: '2026-09-27T02:00:00Z'
            endpoint_id: whk_01K62QZ8V4X9C3N7M5T2R8W6HB
            event_id: evt_01K62QZ8V4X9C3N7M5T2R8W6HC
            event_type: augmentation.completed
            id: dlv_9f1c2b7e4a5d4e8f9a0b1c2d3e4f5a6b
            last_response_status: 503
            next_attempt_at: '2026-09-27T02:06:00Z'
            object: webhook_delivery
            status: pending
          object: webhook_endpoint
          status: active
          url: https://example.com/kite
    ApiErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorBody'
      type: object
      required:
        - error
      title: ApiErrorResponse
      description: Every /v1 error has this shape.
    WebhookDelivery:
      properties:
        id:
          type: string
          title: Id
          description: '`dlv_` + 32 hex characters'
        object:
          type: string
          enum:
            - webhook_delivery
          const: webhook_delivery
          title: Object
          default: webhook_delivery
        endpoint_id:
          type: string
          title: Endpoint Id
        event_id:
          type: string
          title: Event Id
        event_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Event Type
        status:
          type: string
          title: Status
          description: >-
            `pending` (queued, or waiting to retry), `delivered` (the endpoint
            answered 2xx), or `failed` (every attempt failed, or it was not
            sent)
        attempts:
          type: integer
          title: Attempts
          description: >-
            POSTs made so far. At most 6: the first, then retries after 1 min, 5
            min, 30 min, 2 h and 8 h
        last_response_status:
          anyOf:
            - type: integer
            - type: 'null'
          title: Last Response Status
          description: >-
            The HTTP status the endpoint last answered with; null when no answer
            arrived
        last_error:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Error
          description: >-
            Why the last attempt failed when the status does not say: no answer
            (timeout, TLS, DNS, connection), a redirect, or not sent at all
        next_attempt_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Attempt At
          description: When it goes out next, while `pending`
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
      type: object
      required:
        - id
        - endpoint_id
        - event_id
        - status
        - attempts
      title: WebhookDelivery
      description: >-
        One event sent to one endpoint: where it stands, and how its latest
        attempt went.
      examples:
        - attempts: 2
          created_at: '2026-09-27T02:00:00Z'
          endpoint_id: whk_01K62QZ8V4X9C3N7M5T2R8W6HB
          event_id: evt_01K62QZ8V4X9C3N7M5T2R8W6HC
          event_type: augmentation.completed
          id: dlv_9f1c2b7e4a5d4e8f9a0b1c2d3e4f5a6b
          last_response_status: 503
          next_attempt_at: '2026-09-27T02:06:00Z'
          object: webhook_delivery
          status: pending
    ApiErrorBody:
      properties:
        type:
          type: string
          title: Type
          description: >-
            invalid_request_error, authentication_error, permission_error,
            not_found_error, conflict_error, rate_limit_error, or api_error
        code:
          type: string
          title: Code
          description: 'Machine-readable: branch on this, not on the message'
        message:
          type: string
          title: Message
        param:
          anyOf:
            - type: string
            - type: 'null'
          title: Param
          description: The request field the error is about, when there is one
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: Also in the X-Request-Id header; quote it to support
        details:
          anyOf:
            - type: object
            - type: 'null'
          title: Details
          description: >-
            Extra data for some codes (e.g. the cameras a dataset does have, for
            camera_not_found)
      type: object
      required:
        - type
        - code
        - message
      title: ApiErrorBody
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Kite API key (`kite_...`), from **Platform API → Keys** in the
        dashboard.

````

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