Video

The Video component allows you to display clickable video links with thumbnails. This is perfect for sharing video content from platforms like YouTube, Vimeo, and Dailymotion with your users.

Due to accessibility constraints, we cannot reliably play the video within the widget itself.

Example Usage

{
  "type": "video",
  "payload": {
    "url": "https://www.youtube.com/watch?v=RG9TMn1FJzc",
    "title": "The incredible ibex defies gravity and climbs a dam | Forces of Nature with Brian Cox - BBC",
    "thumbnailUrl": "https://www.domain.com/image.png"
  }
}

Properties

payload

• url (required): The URL of the video.
• title (required): The title of the video, used for accessibility and displayed as fallback content if needed.
• thumbnailUrl (optional): A custom thumbnail image URL. If not provided, the component will attempt to generate a thumbnail automatically from the video URL. This only works if the video is hosted on YouTube, Vimeo or Dailymotion.

How It Works

When a video message is sent, it appears as a clickable thumbnail with a play button overlay. When clicked, the link opens in a new tab, taking the user directly to the video on its original platform.

If no thumbnail is provided or can be generated, a fallback image icon will be displayed with the video title.