HEheygen
Webhooks

List Webhook Endpoints

Changed on

Returns a paginated list of registered webhook endpoints.

get/v3/webhooks/endpoints

Request

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

Query parameters

limitinteger

Maximum number of endpoints 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": [
    {
      "endpoint_id": "ep_abc123def456",
      "url": "https://example.com/webhook",
      "events": [
        "avatar_video.success",
        "avatar_video.fail"
      ],
      "status": "enabled",
      "created_at": "2024-04-01T12:00:00Z",
      "secret": "whsec_abc123def456"
    }
  ]
}

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