HEheygen
Webhooks

List Webhook Events

Changed on

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

get/v3/webhooks/events

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/webhooks/events
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

event_type'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'

Filter events by type, e.g. 'avatar_video.success'.

entity_idstring

Filter events by entity ID.

limitinteger

Maximum number of events to return (1-100). Default: 10.

tokenstring

Opaque pagination cursor from a previous response's next_token.

Response

Successful response

has_moreboolean

Whether more pages are available

next_tokenstring nullable

Opaque cursor for the next page

Example response

{
  "data": [
    {
      "event_id": "evt_abc123def456",
      "event_type": "avatar_video.success",
      "event_data": {
        "status": "completed",
        "video_id": "v_abc123"
      },
      "created_at": "2024-04-01T12:00:00Z"
    }
  ]
}

Changes

  • 7dfa5e59b4f5Revision changes
    • info

      added the new enum value filler_word_removal.fail to the query request parameter event_type

    • info

      added the new enum value filler_word_removal.success to the query request parameter event_type

    • info

      added the new enum value podcast.fail to the query request parameter event_type

    • info

      added the new enum value podcast.success to the query request parameter event_type

    • info

      added the new enum value video_generation.fail to the query request parameter event_type

    • info

      added the new enum value video_generation.success to the query request parameter event_type

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status