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

# Get partner webhook configuration

> Returns the stored webhook URL, `enabled` flag, signature metadata, and `updated_at` for
the authenticated partner. If no configuration has been saved yet, the response body is
empty (`{}`).

Use this to verify settings before relying on [`PUT /webhook`](/api-reference/webhooks/configure-webhook)
or starting analyses with `notify_via_webhook=true`.




## OpenAPI

````yaml /openapi.yaml get /webhook
openapi: 3.0.1
info:
  title: Ochy Partner API
  version: 1.0.0
  description: >
    The Ochy Partner API lets you integrate running biomechanical analysis into
    your application.

    Upload a video of a runner, receive detailed biomechanical metrics, joint
    angles, running style

    classification, and frame-by-frame position data.
servers:
  - url: https://partner-api.ochy-prod.com
    description: Production
security:
  - apiKey: []
paths:
  /webhook:
    get:
      tags:
        - Webhooks
      summary: Get partner webhook configuration
      description: >
        Returns the stored webhook URL, `enabled` flag, signature metadata, and
        `updated_at` for

        the authenticated partner. If no configuration has been saved yet, the
        response body is

        empty (`{}`).


        Use this to verify settings before relying on [`PUT
        /webhook`](/api-reference/webhooks/configure-webhook)

        or starting analyses with `notify_via_webhook=true`.
      operationId: getWebhook
      responses:
        '200':
          description: Current webhook configuration (or empty object if none exists).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerWebhookConfigResponse'
              examples:
                configured:
                  summary: Webhook configured
                  value:
                    url: https://client.example.com/webhooks/ochy
                    enabled: true
                    updated_at: '2026-03-23T10:45:00Z'
                    signature:
                      enabled: true
                      algorithm: HMAC-SHA256
                      last4: n6p8
                      created_at: '2026-03-23T10:45:00Z'
                      updated_at: '2026-03-23T10:45:00Z'
                not_configured:
                  summary: No webhook saved yet
                  value: {}
        '401':
          description: Missing API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthErrorResponse'
        '403':
          description: Invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthErrorResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    PartnerWebhookConfigResponse:
      type: object
      description: >
        Returned by `GET /webhook` and `PUT /webhook`. When no webhook has been
        stored yet,

        `GET /webhook` returns an empty object. The full signing secret is only
        present in

        responses that generated or rotated it.
      properties:
        url:
          type: string
          format: uri
          description: Registered webhook URL.
          example: https://client.example.com/webhooks/ochy
        enabled:
          type: boolean
          description: Whether webhook delivery is enabled for this partner.
          example: true
        updated_at:
          type: string
          format: date-time
          description: When the configuration was last updated (ISO 8601 UTC).
          example: '2026-03-23T10:45:00Z'
        signature:
          $ref: '#/components/schemas/PartnerWebhookSignatureResponse'
    AuthErrorResponse:
      type: object
      properties:
        detail:
          type: string
          example: API Key is missing
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
          example: Internal server error
        code:
          type: string
          description: Machine-readable error code (present on some errors).
          example: insufficient_credits
    PartnerWebhookSignatureResponse:
      type: object
      description: >-
        Webhook signing configuration. The `secret` field is returned only when
        generated or rotated.
      properties:
        enabled:
          type: boolean
          description: Whether Ochy signs webhook requests.
          example: true
        algorithm:
          type: string
          description: Signature algorithm used for webhook requests.
          enum:
            - HMAC-SHA256
          example: HMAC-SHA256
        last4:
          type: string
          description: >-
            Last four characters of the current signing secret, for
            identification.
          example: n6p8
        created_at:
          type: string
          format: date-time
          description: When the current signing secret was created (ISO 8601 UTC).
          example: '2026-03-23T10:45:00Z'
        updated_at:
          type: string
          format: date-time
          description: When the signature configuration was last updated (ISO 8601 UTC).
          example: '2026-03-23T10:45:00Z'
        secret:
          type: string
          description: >-
            Full signing secret. Returned only when generated or rotated; store
            it securely.
          example: YOUR_GENERATED_SIGNING_SECRET
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: apiKey
      description: Your API key, passed as a query parameter on every request.

````