Developers

Receive generated video completion events.

Webhooks let BHuman send generated video details to your workflow when asynchronous rendering finishes.

API guideGenerated assets

Model

What webhooks do

A webhook is an HTTPS destination that receives generated video completion data. Use webhooks when your CRM, product, landing page, or workflow needs to attach video assets after rendering.

Settings

Saved webhooks

  1. 01

    Open Settings

    Go to Settings and open Webhooks.
  2. 02

    Add a URL and name

    Enter the HTTPS webhook URL and a recognizable name.
  3. 03

    Save the destination

    Saved webhooks can be listed and removed later.
  4. 04

    Use in generation

    Use callback_url or the configured campaign destination when triggering renders.

Payload

Callback payload

Completion payload

JSON
{
  "id": "c10ee155-6202-4cec-9a40-dde536e2ab4e",
  "status": "succeeded",
  "share_url": "https://videos.bhuman.ai/video/...",
  "url": "https://assets.bhuman.ai/generated-video.mp4",
  "thumbnail": "https://assets.bhuman.ai/thumb.jpg",
  "gif": "https://assets.bhuman.ai/preview.gif",
  "message": "",
  "row_index": 0
}
id
Generated video ID.
status
Render state.
share_url
Hosted share URL when available.
url
MP4 URL when available.
thumbnail
Generated thumbnail.
gif
Generated GIF preview.
message
Failure or processing detail.

Receiver

Receiver requirements

  • Use HTTPS.
  • Respond quickly with a 2xx status.
  • Handle duplicate delivery safely.
  • Store generated video IDs for reconciliation.
  • Log failed payload processing so missing videos can be recovered by polling.

Use polling as a backstop

If a receiver is unavailable, poll generated video endpoints by campaign ID, video instance ID, or generation ID.
Generated assetsUnderstand output fields and statuses.API guideUse callback_url and polling endpoints.