Core concepts

VideoIntros

A Video Intro is one short video from one member for one recipient, on a page in the organization’s brand.

Two ways to create one

Best for CRM integrations

Trigger a Touchpoint

Tell VideoIntros what happened and let the organization’s configured touchpoint determine the experience.

Follow Up Boss
Under Contract
VideoIntros

POST/v1/touchpoint-events

Best for custom applications

Create a Video Intro

Create a Video Intro directly with your own context, instructions and delivery behavior.

Your application
VideoIntros

POST/v1/video-intros

Both run through the same creation engine. A touchpoint event lets the organization’s configuration decide the script and the page. A direct request lets your application decide.

	Trigger a Touchpoint	Create a Video Intro
You send	The moment that happened	The Video Intro itself
Script and page	From the organization’s touchpoint	From your request
Best for	CRM integrations	Custom applications
Endpoint	`POST /v1/touchpoint-events`	`POST /v1/video-intros`

Its life

requestedWaiting for the member to record
readyRecorded
sentDelivered to the recipient

A Video Intro can also end as cancelled or expired. Retrieve one to see where it stands, or listen for webhooks.

The object

statusstring
requested: waiting for the member to record. ready: recorded. sent: delivered to the recipient. cancelled or expired: stopped.
touchpointstring or null
The touchpoint slug when it came from a touchpoint event; null when created directly.
delivery.recipient_urlstring or null
The recipient's page, once the video is recorded.

video_intro

{
  "id": "vi_5b0e7c1e-2a64-4d0f-9b1c-7d2f6a8e9c10",
  "object": "video_intro",
  "status": "requested",
  "touchpoint": null,
  "member": {
    "id": "mem_3f9a1c27",
    "external_id": "rep_456",
    "first_name": "Anthony",
    "last_name": "Baker"
  },
  "recipient": {
    "first_name": "Andrea",
    "last_name": "Smith",
    "phone": "+12405550100"
  },
  "reference": {
    "source": "your_app",
    "type": "order",
    "id": "order_981"
  },
  "delivery": {
    "responsibility": "integration",
    "recipient_url": null
  },
  "metadata": {
    "order_id": "order_981"
  },
  "environment": "test",
  "created_at": "2026-10-05T17:40:01Z"
}