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

# List Webhook Endpoints

> Retrieve a list of all webhook endpoints configured for your account.
Webhooks allow you to receive real-time notifications about events in your JoggAI workspace.


Retrieve a list of all webhook endpoints configured in your account.

Webhooks allow you to receive real-time notifications about events in your JoggAI workspace.

<Info>
  **Limit**: Each user can create up to **20** webhook endpoints.
</Info>

## Use Cases

* View all configured webhook endpoints
* Manage event subscriptions
* Monitor webhook status
* Check enabled/disabled endpoints

## Response Fields

| Field         | Type    | Description                              |
| ------------- | ------- | ---------------------------------------- |
| `endpoint_id` | string  | Unique webhook endpoint identifier       |
| `url`         | string  | Webhook receiver URL                     |
| `secret`      | string  | Secret key for signature verification    |
| `status`      | string  | Endpoint status: `enabled` or `disabled` |
| `events`      | array   | List of subscribed event types           |
| `created_at`  | integer | Creation timestamp                       |

## Best Practices

<Tip>
  Regularly check webhook endpoint status to ensure critical event endpoints are `enabled`.
</Tip>

<Note>
  If you no longer need a webhook, we recommend using [Delete Webhook Endpoint](/api-reference/v2/Webhook/DeleteWebhookEndpoint) to remove it and free up your quota.
</Note>


## OpenAPI

````yaml GET /v2/endpoints
openapi: 3.0.1
info:
  title: JoggAI OpenAPI v2
  description: >
    JoggAI OpenAPI v2 provides a comprehensive suite of endpoints for creating
    and managing AI-powered video content.


    ## Authentication

    All API requests require authentication using an API key provided in the
    `x-api-key` header.


    ## Base URL

    Production: https://api.jogg.ai/v2


    ## Rate Limiting

    API calls are subject to rate limiting based on your subscription plan.


    ## Error Handling

    All endpoints return standard HTTP status codes along with detailed error
    messages in the response body.
  version: 2.0.0
  license:
    name: MIT
servers:
  - url: https://api.jogg.ai
    description: Production server
security:
  - apiKeyAuth: []
tags:
  - name: Video
    description: Video creation and management operations
  - name: Avatar
    description: Avatar management and creation operations
  - name: Voice
    description: Voice and timbre management operations
  - name: Asset
    description: Asset management including music, scripts, and uploads
  - name: Template
    description: Template management operations
  - name: Product
    description: Product management operations
  - name: User
    description: User account operations
  - name: Webhook
    description: Webhook endpoint management for event notifications
paths:
  /v2/endpoints:
    get:
      tags:
        - Webhook
      summary: List Webhook Endpoints
      description: >
        Retrieve a list of all webhook endpoints configured for your account.

        Webhooks allow you to receive real-time notifications about events in
        your JoggAI workspace.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/BaseResponse'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          endpoints:
                            type: array
                            items:
                              $ref: '#/components/schemas/WebhookEndpoint'
components:
  schemas:
    BaseResponse:
      type: object
      required:
        - code
        - msg
      properties:
        code:
          type: integer
          description: |
            Business status code:
            * 0 - Success
            * 10104 - Record not found
            * 10105 - Invalid API key
            * 18020 - Insufficient credit
            * 18025 - No permission to call APIs
            * 40000 - Parameter error
            * 50000 - System error
          example: 0
        msg:
          type: string
          description: Response message
          example: Success
    WebhookEndpoint:
      type: object
      properties:
        endpoint_id:
          type: string
          description: Unique webhook endpoint identifier
          example: wh_123456789
        url:
          type: string
          format: uri
          description: Webhook endpoint URL
          example: https://your-domain.com/webhook
        secret:
          type: string
          description: Secret key for verifying webhook signatures
          example: whsec_abc123xyz
        status:
          type: string
          description: Webhook status
          enum:
            - enabled
            - disabled
          example: enabled
        events:
          type: array
          description: Subscribed event types
          items:
            type: string
          example:
            - generated_avatar_video_success
            - generated_avatar_video_failed
        username:
          type: string
          description: Username of the webhook owner
          example: johndoe
        created_at:
          type: integer
          description: Creation timestamp (Unix timestamp)
          example: 1732806631
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Obtain your key from the JoggAI dashboard.

````