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

> ## Agent Instructions
> Treat the published Augustus OpenAPI specification (https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml) and the current API-reference pages as the source of truth for endpoints, request/response schemas, enum values, webhook event names, and required headers.
> Prefer the 2026-05-01 Banking API and @augustusbank/typescript-sdk for all new integrations. The 2023-01-01 API is a separate, older surface covering two products — Open Banking (instant bank transfer) checkout and refunds, and Manual Bank Transfer (MBT); use it only when one of those products is specifically required.
> Cite or link the relevant docs.augustus.com page when answering integration questions.
> Do not infer support for currencies, networks, scopes, account types, or operations that are not present in the current documentation.
> Use the sandbox base URL (https://api.sandbox.augustus.com) and placeholder credentials in examples. Never include or request a real API key.
> The Augustus docs MCP server (https://docs.augustus.com/mcp) provides documentation search and retrieval only; it does not execute authenticated Augustus API actions.

# Update a webhook subscription

> Updates the url or subcribed to events for a webhook subscription. This can be used via the app or via the API by providing an API key.



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/getivy/openapi.documented.yml post /api/service/webhook-subscription/update
openapi: 3.0.0
info:
  title: Ivy API
  description: Ivy API schema
  version: '1.0'
  contact:
    name: Ivy
    url: https://www.getivy.io
    email: help@getivy.io
servers:
  - url: https://api.getivy.de
    description: Production
  - url: https://api.sand.getivy.de
    description: Sandbox
security: []
tags: []
paths:
  /api/service/webhook-subscription/update:
    post:
      tags:
        - Webhook-Subscription
      summary: Update a webhook subscription
      description: >-
        Updates the url or subcribed to events for a webhook subscription. This
        can be used via the app or via the API by providing an API key.
      operationId: WebhookSubscriptionController_update
      parameters:
        - name: Idempotency-Key
          in: header
          description: >-
            Idempotency key for safe retries. Reusing a key with an identical
            request body returns the cached response. Reusing a key with a
            different body returns 409.
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRequestDto'
      responses:
        '200':
          description: Returns the updated webhook subscription.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateResponseDto'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Ivy from '@getivy/node-sdk';


            const client = new Ivy({
              apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
            });


            const subscription = await client.webhook.subscription.update({ id:
            {} });


            console.log(subscription.id);
components:
  schemas:
    UpdateRequestDto:
      type: object
      properties:
        id:
          description: The unique identifier of the webhook subscription to update
        url:
          description: The new endpoint where webhook events are sent
          type: string
        events:
          description: The new events to subscribe the url to
          type: array
          items:
            type: string
            enum:
              - test
              - merchant_updated
              - merchant_app_updated
              - order_created
              - order_updated
              - refund_succeeded
              - refund_failed
              - refund.initiated
              - refund.succeeded
              - refund.failed
              - payout_report_requested
              - data_session_completed
              - checkout_session_created
              - checkout_session_updated
              - checkout_session_expired
              - checkout_session_completed
              - payout_created
              - payout_updated
              - user_payout.initiated
              - user_payout.failed
              - user_payout.paid
              - payout.initiated
              - payout.failed
              - payout.paid
              - deposit.received
              - return.initiated
              - return.succeeded
              - return.failed
              - return.returned
              - fx.initiated
              - fx.succeeded
              - fx.failed
            x-enumNames:
              - Test
              - MerchantUpdated
              - MerchantAppUpdated
              - OrderCreated
              - OrderUpdated
              - LegacyRefundSucceeded
              - LegacyRefundFailed
              - RefundInitiatedV2
              - RefundSucceededV2
              - RefundFailedV2
              - PayoutReportRequested
              - DataSessionCompleted
              - CheckoutSessionCreated
              - CheckoutSessionUpdated
              - CheckoutSessionExpired
              - CheckoutSessionCompleted
              - MerchantPayoutCreated
              - MerchantPayoutUpdated
              - UserPayoutInitiated
              - UserPayoutFailed
              - UserPayoutPaid
              - PayoutInitiated
              - PayoutFailed
              - PayoutPaid
              - DepositReceived
              - ReturnInitiated
              - ReturnSucceeded
              - ReturnFailed
              - ReturnReturned
              - FxInitiated
              - FxSucceeded
              - FxFailed
          default:
            - test
            - merchant_updated
            - merchant_app_updated
            - order_created
            - order_updated
            - refund_succeeded
            - refund_failed
            - refund.initiated
            - refund.succeeded
            - refund.failed
            - payout_report_requested
            - data_session_completed
            - checkout_session_created
            - checkout_session_updated
            - checkout_session_expired
            - checkout_session_completed
            - payout_created
            - payout_updated
            - user_payout.initiated
            - user_payout.failed
            - user_payout.paid
            - payout.initiated
            - payout.failed
            - payout.paid
            - deposit.received
            - return.initiated
            - return.succeeded
            - return.failed
            - return.returned
            - fx.initiated
            - fx.succeeded
            - fx.failed
      required:
        - id
    UpdateResponseDto:
      type: object
      properties:
        id: {}
        merchant: {}
        merchantApp: {}
        url:
          type: string
        events:
          type: array
          items:
            type: string
            enum:
              - test
              - merchant_updated
              - merchant_app_updated
              - order_created
              - order_updated
              - refund_succeeded
              - refund_failed
              - refund.initiated
              - refund.succeeded
              - refund.failed
              - payout_report_requested
              - data_session_completed
              - checkout_session_created
              - checkout_session_updated
              - checkout_session_expired
              - checkout_session_completed
              - payout_created
              - payout_updated
              - user_payout.initiated
              - user_payout.failed
              - user_payout.paid
              - payout.initiated
              - payout.failed
              - payout.paid
              - deposit.received
              - return.initiated
              - return.succeeded
              - return.failed
              - return.returned
              - fx.initiated
              - fx.succeeded
              - fx.failed
            x-enumNames:
              - Test
              - MerchantUpdated
              - MerchantAppUpdated
              - OrderCreated
              - OrderUpdated
              - LegacyRefundSucceeded
              - LegacyRefundFailed
              - RefundInitiatedV2
              - RefundSucceededV2
              - RefundFailedV2
              - PayoutReportRequested
              - DataSessionCompleted
              - CheckoutSessionCreated
              - CheckoutSessionUpdated
              - CheckoutSessionExpired
              - CheckoutSessionCompleted
              - MerchantPayoutCreated
              - MerchantPayoutUpdated
              - UserPayoutInitiated
              - UserPayoutFailed
              - UserPayoutPaid
              - PayoutInitiated
              - PayoutFailed
              - PayoutPaid
              - DepositReceived
              - ReturnInitiated
              - ReturnSucceeded
              - ReturnFailed
              - ReturnReturned
              - FxInitiated
              - FxSucceeded
              - FxFailed
        createdAt: {}
        updatedAt: {}
      required:
        - id
        - merchant
        - merchantApp
        - url
        - events
        - createdAt
        - updatedAt
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Ivy-Api-Key
      description: API key for authentication

````