> ## 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.

# Ping a webhook subscription

> Sends a test ping to verify webhook subscription endpoint connectivity.



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/getivy/openapi.documented.yml post /api/service/webhook-subscription/ping
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/ping:
    post:
      tags:
        - Webhook-Subscription
      summary: Ping a webhook subscription
      description: Sends a test ping to verify webhook subscription endpoint connectivity.
      operationId: WebhookSubscriptionController_retrieve
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PingRequestDto'
      responses:
        '200':
          description: Returns the ping result with response details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PingResponseDto'
      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 response = await client.webhook.subscription.ping({ id: {} });

            console.log(response.id);
components:
  schemas:
    PingRequestDto:
      type: object
      properties:
        id:
          description: The unique identifier of the webhook subscription to ping
      required:
        - id
    PingResponseDto:
      type: object
      properties:
        id:
          description: The unique identifier of the webhook subscription
        success:
          description: Whether the ping was successful
          type: boolean
        response:
          description: The response from the webhook endpoint
        statusCode:
          description: The HTTP status code returned by the webhook endpoint
          type: number
        date:
          description: The timestamp when the ping was executed
      required:
        - id
        - success
        - response
        - statusCode
        - date
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Ivy-Api-Key
      description: API key for authentication

````