Sign in

v1

latestOpenAPI 3.1.02026-07-1353090.4 KB
Webhooks

Add a Webhook Endpoint

post/v1/webhook/endpoint.add

Request body

urlstring

The URL where you will receive events from HeyGen.

eventsstring[]

The events that your URL is set to receive. None means all events. You can see supported events at /v1/webhook/webhook.list.

entity_idstring

Optional. The specific entity ID associated with the webhook. eg. video_id,project_id

Response

200

codeinteger
{"stackTrail":"paths:/v1/webhook/endpoint.add:post:responses:200:content:application/json:schema:properties:msg","oasType":"schema","type":"unknown"}

Example response

{
  "code": 100,
  "data": {
    "endpoint_id": "038fb5f9a62d48e5af08834d20404606",
    "username": "123456",
    "url": "https://helloworld.com",
    "status": "enabled",
    "secret": "whsec_123456",
    "created_at": "2023-04-03T05:40:46.769845"
  }
}