Search documentation
Search pages, API reference sections, and guide headings.
Summary
This guide shows how to scope webhook events, validate signed deliveries, monitor delivery history, control downstream delivery, and maintain signing trust.
Route platform events
curl -X POST https://playground-api-stg-udk7d32fva-uc.a.run.app/api/v2/webhooks \
-H "Authorization: Bearer <token-or-api-key>" \
-H "Content-Type: application/json" \
-d '{
"name": "Prompt terminal notifications",
"url": "https://example.com/webhooks/videovector",
"events": ["prompt_run.completed", "prompt_run.failed"],
"index_ids": ["idx_archive"],
"metadata": {"owner":"review-ops"}
}'
Save the returned secret immediately. It is shown at creation time and after secret rotation.
Validate event delivery
Use the test endpoint after creation and after any destination change.
webhook = client.webhooks.create(
name="Review events",
url="https://example.com/webhooks/videovector",
events=["prompt_run.completed", "export.ready"],
)
client.webhooks.test(webhook.webhook_id)
Control downstream delivery
Pause a webhook when the downstream system is temporarily unavailable. Delete only when the integration should no longer exist.
Monitor delivery history
The public delivery surface includes:
- delivery status
- attempt counts
- response status codes
- response bodies
- retry scheduling fields
- payload inspection
Retry a failed delivery when the downstream issue is resolved.
curl -X POST https://playground-api-stg-udk7d32fva-uc.a.run.app/api/v2/webhooks/deliveries/del_123/retry \
-H "Authorization: Bearer <token-or-api-key>"
Maintain signing trust
Rotate the webhook secret when:
- the destination owner changes
- the secret may have been exposed
- your security policy requires scheduled rotation
Secret rotation changes future delivery signatures. Update the receiving system before you rely on the new secret in production traffic.
Related documentation
Webhooks deliver VideoVector events to your HTTPS endpoint for review operations, export handoff, import monitoring, and media processing automation.
VideoVector exposes a public workflow layer for storage integration and downstream delivery. This page explains connectors, jobs, automations, exports, and event delivery as one model.
API keys are the primary credential for public workflow access. This guide shows how to create them, scope them, and rotate them without breaking integrations.
