HEheygen
Webhooks

Update Webhook Endpoint

Changed on

Updates the URL and/or subscribed event types for a webhook endpoint. The events array is fully replaced — include all types you want to keep.

patch/v3/webhooks/endpoints/{endpoint_id}

Request

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

Path parameters

endpoint_idstring required

Webhook endpoint ID

Request body

urlstring nullable

New URL for the endpoint. Must be publicly accessible HTTPS.

eventsWebhookEventType[] nullable

New list of event types to subscribe to. Replaces the existing list.

Response

Successful response

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 new filler_word_removal.fail enum value to the request property //

    • info

      added the new filler_word_removal.success enum value to the request property //

    • info

      added the new podcast.fail enum value to the request property //

    • info

      added the new podcast.success enum value to the request property //

    • info

      added the new video_generation.fail enum value to the request property //

    • info

      added the new video_generation.success enum value to the request property //

    • 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

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status