> ## Documentation Index
> Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List Webhook Events

> Returns a paginated history of delivered webhook events. Filterable by event_type or entity_id.



## OpenAPI

````yaml /openapi/external-api.json get /v3/webhooks/events
openapi: 3.1.0
info:
  title: HeyGen External API
  version: 1.0.0
  description: >-
    HeyGen's external API for programmatic AI video creation. See
    https://docs.heygen.com for full documentation.
  contact:
    name: HeyGen Product Infra
    url: https://heygen.com
servers:
  - url: https://api.heygen.com
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Video
    description: >-
      Create videos from a prompt or an avatar, then list, fetch, deliver and
      delete them
  - name: Avatar
    description: >-
      Create avatars and looks, record consent, and generate with the Avatar 6
      model
  - name: Voice
    description: Text to speech, speech to speech, and voice cloning
  - name: Audio
    description: Music, sound effects, transcription, stem separation and audio analysis
  - name: Image
    description: Generate images
  - name: Video editing
    description: >-
      Translate, lipsync, clip, analyze and remove filler words or backgrounds
      from existing videos
  - name: Video Agent
    description: Create videos from a prompt with an agent that plans, writes and edits
  - name: Templates
    description: Generate videos from reusable templates by replacing their variables
  - name: HyperFrames
    description: Render HyperFrames compositions into video
  - name: Brand
    description: >-
      Brand kits (colors, fonts, logos) and brand glossaries (term translations
      and pronunciations)
  - name: Assets and folders
    description: Upload files and organize them in folders
  - name: Batches
    description: Submit and track videos, translations, lipsyncs and uploads in bulk
  - name: Webhooks
    description: Manage webhook endpoints and events
  - name: Feedback
    description: Tell HeyGen how a generated result turned out
  - name: Account and usage
    description: Your account, the current API key, request logs and usage
paths:
  /v3/webhooks/events:
    get:
      tags:
        - Webhooks
      summary: List Webhook Events
      description: >-
        Returns a paginated history of delivered webhook events. Filterable by
        event_type or entity_id.
      operationId: listWebhookEvents
      parameters:
        - name: event_type
          in: query
          required: false
          description: Filter events by type, e.g. 'avatar_video.success'.
          schema:
            type: string
            enum:
              - avatar_video.success
              - avatar_video.fail
              - avatar_video_gif.success
              - avatar_video_gif.fail
              - video_translate.success
              - video_translate.fail
              - video_translate.preflight.validation_failed
              - video_translate.preflight.download_failed
              - personalized_video
              - instant_avatar.success
              - instant_avatar.fail
              - photo_avatar_generation.success
              - photo_avatar_generation.fail
              - photo_avatar_train.success
              - photo_avatar_train.fail
              - photo_avatar_add_motion.success
              - photo_avatar_add_motion.fail
              - proofread_creation.success
              - proofread_creation.fail
              - live_avatar.success
              - live_avatar.fail
              - avatar_video_caption.success
              - avatar_video_caption.fail
              - video_agent.success
              - video_agent.fail
              - hyperframes_video.success
              - hyperframes_video.fail
              - ai_clipping.success
              - ai_clipping.fail
              - filler_word_removal.success
              - filler_word_removal.fail
              - podcast.success
              - podcast.fail
              - batch.finished
              - video_generation.success
              - video_generation.fail
              - video_delivery.success
              - video_delivery.fail
        - name: entity_id
          in: query
          required: false
          description: Filter events by entity ID.
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: 'Maximum number of events to return (1-100). Default: 10.'
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
        - name: token
          in: query
          required: false
          description: Opaque pagination cursor from a previous response's next_token.
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookEventResponse'
                  has_more:
                    type: boolean
                    description: Whether more pages are available
                  next_token:
                    type:
                      - string
                      - 'null'
                    description: Opaque cursor for the next page
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: invalid_parameter
                  message: '''limit'' must be between 1 and 100.'
                  param: limit
                  doc_url: null
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: unauthorized
                  message: Invalid or expired API key. Verify your x-api-key header.
                  param: null
                  doc_url: null
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Retry after the duration specified in the
                    Retry-After header.
                  param: null
                  doc_url: null
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    WebhookEventResponse:
      description: A delivered webhook event.
      properties:
        event_id:
          description: Unique identifier for this event delivery.
          examples:
            - evt_abc123def456
          title: Event Id
          type: string
        event_type:
          description: The event type, e.g. 'avatar_video.success'.
          examples:
            - avatar_video.success
          title: Event Type
          type: string
        event_data:
          additionalProperties: true
          description: The event payload data.
          examples:
            - status: completed
              video_id: v_abc123
          title: Event Data
          type: object
        created_at:
          description: ISO 8601 timestamp when the event was created.
          examples:
            - '2024-04-01T12:00:00Z'
          title: Created At
          type: string
      required:
        - event_id
        - event_type
        - event_data
        - created_at
      title: WebhookEventResponse
      type: object
    StandardAPIError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: invalid_parameter
        message:
          type: string
          description: Human-readable error message
          example: Video not found
        param:
          type:
            - string
            - 'null'
          description: Which request field caused the error
        doc_url:
          type:
            - string
            - 'null'
          description: Link to error documentation
        errors:
          type: array
          description: >-
            Per-item error details for batch/multi-node failures (e.g. graph
            compilation errors by node).
          items:
            $ref: '#/components/schemas/StandardAPIErrorDetail'
        request_id:
          type: string
          description: >-
            Request identifier, also returned in the X-HeyGen-Request-Id
            response header. Include it when contacting support.
          example: 8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40
      required:
        - code
        - message
    StandardAPIErrorDetail:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: unknown_node_type
        message:
          type: string
          description: Human-readable error message
          example: Unknown node type
        node_id:
          type: string
          description: Graph node id this error pertains to, if applicable
        port:
          type: string
          description: Port name on the node this error pertains to, if applicable
        path:
          type: string
          description: Field path within the item this error pertains to, if applicable
      required:
        - code
        - message
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: HeyGen API key. Obtain from your HeyGen dashboard.
    BearerAuth:
      type: http
      scheme: bearer
      description: OAuth2 bearer token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.