Core concepts

References

A reference is your record: the appointment, job, deal or contact the moment is about.

Why send one

Video Intros stores the reference with the event and the Video Intro, and returns it on every response and webhook. It is how you match what happened in Video Intros back to a row in your system without keeping a lookup table.

Fields

sourcestring
The system the record lives in, for example your_crm.
typestring
What kind of record: appointment, job, deal, contact.
idstring
Its identifier in that system.

Find it again

List Video Intros with reference_id to get the Video Intro for a record.

reference

{
  "reference": {
    "source": "your_crm",
    "type": "appointment",
    "id": "appointment_123"
  }
}