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

# Update a webhook

> Partially updates a webhook. All fields are optional - only supplied fields
are modified. To pause deliveries without deleting the endpoint, set
`enabled` to `false`. To resume, set it back to `true`. The `secret` is
not returned in update responses.



## OpenAPI

````yaml /api-reference/openapi.yaml patch /webhooks/{id}
openapi: 3.0.3
info:
  title: Polygon OMS Public API
  version: v26.05.28-0001
  description: >-
    Unified API for moving money between crypto and fiat. Three ways to move
    money: Transactions (instant, wallet or card funded, including Cash-In for
    in-person cash deposits), Deposit Addresses (reusable crypto deposit
    configurations), and Virtual Accounts (dedicated bank accounts that
    auto-convert fiat to crypto). Standard transactions follow a two-step flow:
    create a Quote (pricing), then create a Transaction (execution). Cash-in
    codes generate a one-time deposit code for in-person cash deposits at retail
    locations.
  contact:
    name: Polygon OMS
    url: https://oms.polygon.technology
servers:
  - url: https://sandbox-api.polygon.technology/v0.9
    description: Sandbox
  - url: https://api.polygon.technology/v0.9
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Auth
    description: Authentication via FrontEgg
  - name: Customers
    description: Customer management and KYC
  - name: Customer
  - name: Wallet
  - name: Quote
  - name: Transaction
  - name: Webhook
  - name: CashIns
  - name: CashLocation
  - name: Sandbox
  - name: Simulation
paths:
  /webhooks/{id}:
    patch:
      tags:
        - Webhook
      summary: Update a webhook
      description: >-
        Partially updates a webhook. All fields are optional - only supplied
        fields

        are modified. To pause deliveries without deleting the endpoint, set

        `enabled` to `false`. To resume, set it back to `true`. The `secret` is

        not returned in update responses.
      operationId: updateWebhook
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookUpdateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: The request has succeeded.
components:
  schemas:
    WebhookUpdateRequest:
      properties:
        enabled:
          description: Set to `false` to pause deliveries; `true` to resume them.
          type: boolean
        events:
          description: >-
            Replaces the full events subscription. Pass `[]`, `["*"]`, or
            `["ALL"]`

            to switch to a wildcard (all events) subscription.
          items:
            type: string
          type: array
        url:
          description: New HTTPS endpoint URL. HTTPS is required in non-local environments.
          type: string
      type: object
    Webhook:
      properties:
        complianceOnly:
          description: >-
            When true, this endpoint receives compliance-only events (e.g.
            underReview)

            that are excluded from all regular partner webhooks (AML
            no-tipping-off).

            Can only be set via the admin API.
          type: boolean
        createdAt:
          description: ISO 8601 UTC timestamp of when the webhook was registered.
          format: date-time
          type: string
        enabled:
          description: >-
            Whether OMS is actively delivering events to this endpoint. Set to
            `false`

            to pause deliveries without deleting the endpoint. OMS also sets
            this to

            `false` automatically if the endpoint returns `410 Gone`.
          type: boolean
        events:
          description: >-
            Event types this endpoint subscribes to. An empty array means the
            endpoint

            receives all event types (wildcard). See the event catalog in the
            webhook

            delivery documentation for the full list of valid values.
          items:
            type: string
          type: array
        id:
          description: Unique webhook identifier. Uses the `whk_` prefix.
          type: string
        object:
          description: Resource type discriminator. Always `"webhook"`.
          enum:
            - webhook
          type: string
        secret:
          description: >-
            Signing secret used to verify the `Webhook-Signature` header on
            incoming

            deliveries. Uses the `whsec_` prefix (32 cryptographically random
            bytes,

            hex-encoded). **Returned only on creation** - it cannot be retrieved

            afterward. Store it in your secrets manager immediately.
          type: string
        status:
          $ref: '#/components/schemas/WebhookStatus'
        url:
          description: HTTPS endpoint that OMS delivers event payloads to.
          type: string
      required:
        - complianceOnly
      type: object
    WebhookStatus:
      enum:
        - active
        - disabled
      type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token from POST /auth/token

````