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

# Get webhook configuration

> Retrieve current webhook configuration for the authenticated partner. Returns webhook_url, selected events, masked webhook_secret, and available events.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/integrations/webhooks/
openapi: 3.0.3
info:
  title: Zupy API v2
  version: 2.0.0
  description: >-
    Zupy API v2 — versioned, gateway-aware API with envelope responses, RFC 7807
    errors, and multi-auth support (JWT, API Key, Device Key).
servers:
  - url: https://api.zupy.com
    description: Production
security: []
tags:
  - name: Authentication
    description: OTP request and verification endpoints
  - name: Customers
    description: Customer management, points, history, and data operations
  - name: Loyalty Programs
    description: Loyalty program configuration and details
  - name: Rewards
    description: Loyalty reward catalog (definitions redeemed with points)
  - name: Companies
    description: Company information and loyalty configuration
  - name: Coupons
    description: >-
      Issued coupons (RewardRedemption) — both loyalty-reward redemptions and
      marketing claims
  - name: Wallet
    description: Apple Wallet pass generation and notifications
  - name: Webhooks
    description: Partner integration webhook endpoints
  - name: Webhook Management
    description: Configure and test outbound webhook delivery
paths:
  /api/v2/integrations/webhooks/:
    get:
      tags:
        - Webhook Management
      summary: Get webhook configuration
      description: >-
        Retrieve current webhook configuration for the authenticated partner.
        Returns webhook_url, selected events, masked webhook_secret, and
        available events.
      operationId: integrations_webhooks_retrieve
      parameters:
        - in: header
          name: X-API-Key
          schema:
            type: string
          description: Per-company API key
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookConfigResponse'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
      security:
        - apiKeyAuth: []
components:
  schemas:
    WebhookConfigResponse:
      type: object
      properties:
        webhook_url:
          type: string
          nullable: true
          description: Partner's webhook endpoint URL
        webhook_events:
          type: array
          items:
            type: string
          description: List of events to receive
        webhook_secret:
          type: string
          nullable: true
          description: Masked webhook signature secret (last 4 chars visible)
        available_events:
          type: array
          items:
            type: string
          description: List of available webhook event types
    Error:
      type: object
      description: RFC 7807 Problem Details error response.
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
      required:
        - detail
        - instance
        - status
        - title
        - type
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Per-company partner API key (zupy_pk_…). Validated by Zupy against the
        company integration key hash (Story 14.x); send it on every request as
        the X-API-Key header. Scoped read-write to the owning company's data.

````