API Reference

Add a Webhook Endpoint

post
https://api.heygen.com/v1/webhook/endpoint.add

Registers a webhook endpoint to receive real-time event notifications from HeyGen.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

URL where HeyGen will send event notifications. Only servers with SSL security level 2 or above are supported. To create a webhook endpoint URL, refer to the Write Your Endpoint To Process Webhook Events guide.

events
array of strings

A list of event types your webhook should listen to. If not specified or left null, the webhook will be configured to receive all available events. To view supported event types, refer to the List Available Webhook Events endpoint.

events
string

The specific entity ID associated with the webhook, for example, video_id, project_id, etc. Note: This field is only applicable to translated videos with multiple language versions.

Responses

Updated 6 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago