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

# Get webhook configuration

Retrieve your current webhook configuration

<RequestExample>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl --location 'https://www.headout.com/api/public/v2/webhooks/' \
  --header 'Headout-Auth: <YOUR_API_KEY>'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={"theme":{"light":"github-light","dark":"github-dark"}}
  {
    "timestamp": 1756977128516,
    "message": "Webhook configuration retrieved successfully",
    "data": {
      "url": "https://your-domain.com/webhooks/headout/booking-status",
      "enabled": true
    }
  }
  ```

  ```json 404 theme={"theme":{"light":"github-light","dark":"github-dark"}}
  {
    "timestamp": 1756977128516,
    "error": {
      "code": "WEBHOOK_NOT_FOUND",
      "message": "No webhook configuration found for this partner"
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /api/public/v2/webhooks/
openapi: 3.1.0
info:
  title: Headout API Docs - API Partner v2
  version: 0.0.1
servers:
  - url: https://www.headout.com
    description: Production server
  - url: https://www.sandbox-headout.com
    description: Sandbox server
security: []
paths:
  /api/public/v2/webhooks/:
    get:
      tags:
        - Webhooks
      summary: Get webhook configuration
      operationId: v2GetWebhook
      responses:
        '200':
          description: Webhook configuration retrieved successfully
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/GenericResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/PartnerWebhookConfiguration'
        '404':
          description: Webhook configuration not found
      security:
        - apiKeyAuth: []
components:
  schemas:
    GenericResponse:
      type: object
      properties:
        timestamp:
          type: integer
          format: int64
          description: Response timestamp in milliseconds
        message:
          type:
            - string
            - 'null'
          description: Response message
        error:
          $ref: '#/components/schemas/GenericResponseError'
        data:
          type:
            - object
            - 'null'
          description: Response data payload
    PartnerWebhookConfiguration:
      type: object
      properties:
        url:
          type: string
          format: uri
          description: HTTPS URL where webhooks will be delivered
        enabled:
          type: boolean
          description: Whether the webhook is active
    GenericResponseError:
      type: object
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Error message
        detailedMessage:
          type:
            - string
            - 'null'
          description: Detailed error message
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Headout-Auth

````