Events

Retrieve an event

GET/v1/events/{id}

Store the event id you get back when you send an event. This is how you ask what happened to it.

Authentication

A bearer API key. Authentication.

Headers

Authorizationstringrequired
Bearer followed by your API key. A test key works in the test environment only.

Path parameters

idstringrequired
The event's identifier.

Response fields

statusstring
accepted: received and queued. duplicate: this Idempotency-Key was already accepted; nothing new was created. processed: a Video Intro was created. failed: it could not be processed; error says why.
resolvedobject
The organization's touchpoint and the member the event was matched to.
video_introstring or null
The Video Intro this event created.

Errors

Status	Code	When
401	`unauthorized`	The API key is missing, malformed or revoked.
404	`not_found`	No such object in this organization and environment.

All errors

Request

curl https://api.videointros.com/v1/events/evt_8f3c2a71d04e \
  -H "Authorization: Bearer $VIDEO_INTROS_API_KEY"

const response = await fetch("https://api.videointros.com/v1/events/evt_8f3c2a71d04e", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VIDEO_INTROS_API_KEY}`,
  },
});
const result = await response.json();

import os, requests

response = requests.get(
    "https://api.videointros.com/v1/events/evt_8f3c2a71d04e",
    headers={
        "Authorization": f"Bearer {os.environ['VIDEO_INTROS_API_KEY']}",
    },
)
result = response.json()

Response · 200

{
  "id": "evt_8f3c2a71d04e",
  "object": "touchpoint_event",
  "status": "processed",
  "touchpoint": "new_appointment",
  "environment": "test",
  "created_at": "2026-10-05T17:40:01Z",
  "resolved": {
    "touchpoint": {
      "slug": "new_appointment",
      "name": "New Appointment"
    },
    "member": {
      "id": "mem_3f9a1c27",
      "external_id": "rep_456"
    }
  },
  "video_intro": "vi_5b0e7c1e-2a64-4d0f-9b1c-7d2f6a8e9c10",
  "reference": {
    "source": "your_crm",
    "type": "appointment",
    "id": "appointment_123"
  }
}

An error

{
  "error": {
    "code": "not_found",
    "message": "No such object in this organization and environment."
  }
}