Skip to content
Video IntrosDevelopers
TestLive not yet available
videointros.com

Preview Developer preview. The API described here is not available yet. Examples are illustrative and every console screen uses sample data: nothing is sent, created or stored.

Core concepts

Delivery

Delivery is who gets the finished Video Intro to the recipient: your system, or Video Intros.

Two responsibilities

integration Default

Prepare only

Video Intros prepares the Video Intro. When the member has recorded it, you receive the recipient’s link and your system sends it, in your own message, from your own number.

video_intros

Video Intros delivers

Video Intros sends the Video Intro to the recipient by text message, the way it does for the organization today.

On a direct request

Set delivery.responsibility on POST /v1/video-intros. Leave it out and it is integration.

With integration, wait for video_intro.ready or retrieve the Video Intro: delivery.recipient_url is the link to send.

On a touchpoint event

A touchpoint event carries no delivery setting. The organization’s configuration decides what happens after the member records.

Request
{
  "delivery": {
    "responsibility": "integration"
  }
}
Webhook · video_intro.ready
{
  "id": "whe_2d90b7",
  "object": "webhook_event",
  "type": "video_intro.ready",
  "created_at": "2026-10-05T18:02:11Z",
  "environment": "test",
  "data": {
    "id": "vi_5b0e7c1e-2a64-4d0f-9b1c-7d2f6a8e9c10",
    "object": "video_intro",
    "status": "ready",
    "reference": {
      "source": "your_app",
      "type": "order",
      "id": "order_981"
    },
    "delivery": {
      "responsibility": "integration",
      "recipient_url": "https://app.videointros.com/your-company/v/…"
    }
  }
}