Rotate Webhook Signing Secret

Generates a new signing secret for a webhook endpoint and immediately invalidates the old one. Store the new secret securely — it will not be shown again.

POST /v3/webhooks/endpoints/{endpoint_id}/rotate-secret

Rotate Webhook Signing Secret

cURL

curl --request POST \
  --url https://api.heygen.com/v3/webhooks/endpoints/{endpoint_id}/rotate-secret \
  --header 'x-api-key: <api-key>'

200

{
  "data": {
    "endpoint_id": "<string>",
    "secret": "<string>"
  }
}

Authorizations

ApiKeyAuthBearerAuth

x-api-key · string · header · required

HeyGen API key. Obtain from your HeyGen dashboard.

Headers

Idempotency-Key · string

Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 request_in_progress. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.

Required string length: 1 - 255

Pattern: ^[A-Za-z0-9_\-:.]{1,255}$

Path Parameters

endpoint_id · string · required

Webhook endpoint ID

Response

200

application/json

Successful response

data · RotateSecretResponseData · object

Response from rotating a webhook endpoint's signing secret.

Show child attributes