post https://api.heygen.com/v1/webhook/endpoint.add
Set up webhooks for real-time event notifications and automate your workflow
Our webhook validation performs an OPTIONS request to your endpoint with a 1-second timeout, so ensure your server responds quickly and accepts OPTIONS requests, even if your main functionality uses different HTTP methods.
Response
| Field | Type | Description |
|---|---|---|
| endpoint_id | string | id of your registered endpoint |
| url | string | url of your registered endpoint. For https urls, we only support servers with ssl security level 2 and above. |
| secret | string | secret of your registered endpoint. Used to verify the callback request is from HeyGen |
| status | string | status of your registered endpoint. Whether it is enabled or not |
| events | string[] | events of your registered endpoint that listened to. None means all events |
| username | string | username of your registered endpoint. It should be your username |
| created_at | datetime | The timestamp when the endpoint was created. |