For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DashboardAPI PricingGet an API key
  • Guides
    • Introduction
    • Getting started
    • Use with AI agents
    • Examples
    • Authentication
    • Handling async tasks
    • File uploads
    • File hydration
    • Embedding videos
    • Errors
    • Rate limits
    • Libraries & SDKs
  • REST API Reference
    • Overview
    • Workflows
        • POSTGenerate image
        • POSTGenerate video clip
        • POSTText to speech
        • POSTGenerate sound effect
        • POSTGenerate avatar clip
        • POSTVectorize image
        • POSTRemove background from an image
        • POSTRemove background from a video
        • POSTUpscale an image
        • POSTUpscale a video
        • POSTCancel tool execution
        • GETGet tool execution info
        • GETList files
        • POSTSearch files
        • GETGet file
        • POSTCreate file upload
        • POSTHydrate file
        • POSTArchive file
        • POSTEnable public preview
        • POSTDisable public preview
        • GETList avatar presenters
        • GETList TTS voices
        • GETList webhooks
        • POSTCreate webhook
        • DELDelete webhook
  • Webhook events
    • Overview
    • Changelog
LogoLogo
DashboardAPI PricingGet an API key
REST API ReferenceEndpointsWebhooks

Create webhook

POST
https://api.videogen.io/v1/webhooks/endpoints
POST
/v1/webhooks/endpoints
1import { VideoGenClient } from "@videogen/sdk";
2
3const client = new VideoGenClient({ token: "YOUR_TOKEN" });
4await client.webhooks.createWebhookEndpoint({
5    url: "url",
6    events: ["tool_execution.succeeded"]
7});
201Created
1{
2  "endpointId": "string",
3  "url": "string",
4  "events": [
5    "tool_execution.succeeded"
6  ],
7  "createdAt": 1.1,
8  "description": "string",
9  "signingSecret": "string",
10  "signingSecretLast4": "string"
11}

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

Was this page helpful?
Previous

Delete webhook

Next
Built with

Authentication

AuthorizationBearer

API key from app.videogen.io/developers. The full key is only shown once when you create it.

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"
HTTPS URL that will receive webhook POST requests.
eventslist of enumsRequired
descriptionstring or nullOptional

Response

Created; signingSecret is only returned in this response.

endpointIdstring
urlstringformat: "uri"
eventslist of enums
createdAtdouble

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

descriptionstring or null
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.