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

# Update a webhook endpoint

> Change the URL, description or subscriptions, or set `status` to pause (`disabled`) or resume (`active`) delivery. Setting `active` also clears `failureCount` and `disabledReason`, which is how you recover an auto-disabled endpoint. Non-2xx responses and timeouts (10s) are retried at 30s, 2m, 8m, 32m, 2h, 6h, 6h, 6h — about a day — before the delivery is marked failed. After 10 consecutive failed attempts the endpoint is auto-disabled (`disabledReason: consecutive_failures`); re-enable it with PATCH `status: active`.



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/webhooks/endpoints/{id}
openapi: 3.1.0
info:
  title: Chipper Platform API
  version: '2026-02-20'
  description: >-
    Payouts, collections, and FX across African rails — bank, mobile money, and
    stablecoins — through one API.
servers:
  - url: https://sandbox-api.platform.chipper.ai
    description: Sandbox (sk_test_ keys — simulated rails, no real money)
  - url: https://api.platform.chipper.ai
    description: Production (sk_live_ keys)
security:
  - bearerAuth: []
paths:
  /v1/webhooks/endpoints/{id}:
    patch:
      tags:
        - Webhooks
      summary: Update a webhook endpoint
      description: >-
        Change the URL, description or subscriptions, or set `status` to pause
        (`disabled`) or resume (`active`) delivery. Setting `active` also clears
        `failureCount` and `disabledReason`, which is how you recover an
        auto-disabled endpoint. Non-2xx responses and timeouts (10s) are retried
        at 30s, 2m, 8m, 32m, 2h, 6h, 6h, 6h — about a day — before the delivery
        is marked failed. After 10 consecutive failed attempts the endpoint is
        auto-disabled (`disabledReason: consecutive_failures`); re-enable it
        with PATCH `status: active`.
      parameters:
        - schema:
            type: string
            description: Webhook endpoint id.
            example: whe_k3m9x2pq7vn4t8wz1bcd
          required: true
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                description:
                  type:
                    - string
                    - 'null'
                events:
                  type: array
                  items:
                    anyOf:
                      - type: string
                        enum:
                          - '*'
                      - type: string
                        enum:
                          - payout.completed
                          - payout.failed
                          - conversion.completed
                          - account.credited
                          - collection.pending
                          - collection.completed
                          - collection.failed
                          - order.awaiting_funds
                          - order.awaiting_confirmations
                          - order.funds_received
                          - order.processing_payout
                          - order.completed
                          - order.failed
                          - order.expired
                          - order.overpaid
                          - order.underpaid
                          - dispute.created
                          - dispute.updated
                          - dispute.closed
                  minItems: 1
                status:
                  type: string
                  enum:
                    - active
                    - disabled
      responses:
        '200':
          description: The updated endpoint.
          content:
            application/json:
              schema:
                type: object
                properties:
                  endpoint:
                    $ref: '#/components/schemas/WebhookEndpoint'
                required:
                  - endpoint
        '400':
          description: Invalid request — the body failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: validation_error
                message: Request validation failed
                requestId: req_q7vei435zifs51ia0lqr
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: unauthorized
                message: Invalid API key
                requestId: req_q7vei435zifs51ia0lqr
        '404':
          description: No such resource in this organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: not_found
                message: Webhook endpoint not found
                requestId: req_q7vei435zifs51ia0lqr
      security:
        - bearerAuth: []
components:
  schemas:
    WebhookEndpoint:
      type: object
      properties:
        id:
          type: string
          example: whe_k3m9x2pq7vn4t8wz1bcd
        url:
          type: string
          format: uri
          example: https://api.example.com/chipper/webhooks
        description:
          type:
            - string
            - 'null'
          example: Production listener
        events:
          type: array
          items:
            type: string
          description: Subscribed event types, or `["*"]` for all.
          example:
            - payout.completed
            - payout.failed
            - collection.completed
        status:
          type: string
          enum:
            - active
            - disabled
        failureCount:
          type: integer
          description: Consecutive failed attempts. Reset to 0 on the next success.
          example: 0
        disabledReason:
          type:
            - string
            - 'null'
          enum:
            - manual
            - consecutive_failures
          description: >-
            `consecutive_failures` after 10 failed attempts in a row, `manual`
            when you disabled it, null when active.
        createdAt:
          type: string
          format: date-time
          example: '2026-08-01T09:12:44.000Z'
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - url
        - description
        - events
        - status
        - failureCount
        - disabledReason
        - createdAt
        - updatedAt
    Error:
      type: object
      properties:
        error:
          type: string
          description: Stable machine-readable code.
        message:
          type: string
          description: Human-readable explanation.
        requestId:
          type: string
          description: Echoed in the x-request-id response header — quote it to support.
      required:
        - error
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `sk_test_…` (sandbox) or `sk_live_…` (production).'

````