HEheygen
Webhooks

List Webhook Event Types

Changed on

Returns all available webhook event types with human-readable descriptions.

get/v3/webhooks/event-types

Request

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

Response

Successful response

has_moreboolean

Whether more pages are available

next_tokenstring nullable

Opaque cursor for the next page

Example response

{
  "data": [
    {
      "event_type": "avatar_video.success",
      "description": "Fired when an avatar video completes rendering successfully."
    }
  ]
}

Changes

  • 7dfa5e59b4f5Revision changes
    • 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