VIvideogen
Webhooks

Create webhook

Changed on

Register a new webhook endpoint to receive tool_execution.*, workflow_run.*, and file.* events. The signing secret is only returned in this response. Store it securely.

post/v1/webhooks/endpoints

Request

  • Base URL
    https://api.videogen.io
  • Auth
    HTTP bearer

Request body

urlstring uri required

HTTPS URL that will receive webhook POST requests.

descriptionstring nullable
eventsWebhookEventName[] required

Webhook event names to subscribe to. Must contain at least one event.

Response

Created; signingSecret is only returned in this response.

endpointIdstring required

Webhook endpoint id (e.g. ep_...).

urlstring uri required
eventsWebhookEventName[] required
descriptionstring nullable
createdAtinteger required

Seconds since epoch (Unix timestamp) when the endpoint was created.

signingSecretstring

HMAC secret for verifying Standard Webhooks signatures. Only returned once on create; store it securely.

signingSecretLast4string

Last four characters of the signing secret, for display purposes.

Changes

  • f717ffcc857bRevision changes
    • warning

      added the new tool_execution.awaiting_approval enum value to the / response property for the response status

    • warning

      added the new workflow_run.awaiting_approval enum value to the / response property for the response status

    • info

      added the new tool_execution.awaiting_approval enum value to the request property /

    • info

      added the new workflow_run.awaiting_approval enum value to the request property /