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.
Sample appsIntegrationsDiscordPlaygroundDevEx repo
GuidesSDK ReferenceAPI Reference
GuidesSDK ReferenceAPI Reference
  • Get Started
    • Introduction
    • Quickstart
    • Manage your plan
    • Rate limits
    • Release notes
    • Migration guide
  • Guides
    • Search
    • Analyze videos
    • Segment videos
    • Create embeddings
  • Concepts
    • Models
    • Upload and processing methods
    • Indexes
    • Modalities
    • Multimodal large language models
  • Cloud partner integrations
    • Amazon Bedrock
  • Advanced
    • Organizations
    • Fine-tuning
    • Webhooks
      • Manage webhooks
      • Requirements for processing notifications
      • Response schema
    • Metadata
    • Model context protocol
    • Claude Code Plugin
  • Resources
    • Platform overview
    • Playground
    • TwelveLabs SDKs
    • Frequently asked questions
    • Use cases
    • Sample applications
    • Partner integrations
    • From the community
LogoLogo
Sample appsIntegrationsDiscordPlaygroundDevEx repo
On this page
  • Use Webhooks to receive notifications
Advanced

Webhooks

Was this page helpful?
Previous

Manage webhooks

Next
Built with

A webhook allows your application to receive real-time HTTP notifications for events. Currently, this functionality is available for the following events:

  • A video indexing task has finished or failed.
  • An async analysis task has finished or failed.
Note

Webhooks are supported for the Search and Analyze APIs but are unavailable for the Embed API.

Use Webhooks to receive notifications

To receive event notifications for events in your application, use the steps in this section:

  1. Create an HTTP endpoint in your application. The platform sends notifications to your endpoint as POST requests with a JSON payload. For details about the schema, see the Response schema section.
  2. Register your webhook. Once you’ve created an HTTP endpoint in your application, you must go to the Webhooks page and register your webhook. For instructions, see the Register a webhook section.
  3. Handle requests. Ensure that your application meets all the requirements for processing notifications.