Interaction Webhooks

Send each interaction from your videos to a destination of your choosing.

If you are interested in seeing data associated to the when your audience is engaging with your interactions, you can use configure interaction webhooks in your Mindstamp account.

Below is a table showing the results of an interaction webhook.

Value Type Description Example
id Unique ID ID of the interaction 9bce33d1-120c-4bb5-8b5a-499896140f20
video_title String Title of the video Interactive Video #9
type_of String Type of interaction click
value String Selected answer (questions) or label of interaction (button, hotspot, etc.) D. All of the Above
time Integer Second the interaction appears in the video 100
finish Integer Second the interaction disappears in the video 105
parent_id Unique ID ID of the parent of the interaction 9ers33y1-120t-4gs5-8g5s-499896140g20
parent_type String The parent type of the interaction (question, button, hotspot, etc.) question
parent_value String Question Prompt or label of interaction (button, hotspot, etc.) How can you get a good night's sleep?
click_action String The action assigned when a user engages with an interactions link
click_value String Parameter for the click action www.google.com
viewer_name String Viewer's name as received in the URL, info capture, or if they are Mindstamp user John Doe
viewer_email String Viewer's email as received in the URL, info capture, or if they are Mindstamp user [email protected]
viewer_phone String Viewer's phone number as received in the URL, info capture, or if they are Mindstamp user (321) 123-4567
viewer_custom_id String Viewer's custom ID number as received in the URL or info capture 123456
style String Type of question (free response, multiple choice, show poll, etc.) multiple
answers List Array of answers for a question interaction [
  "A. No coffee past 2pm",
  "B. Don't nap past 4pm",
  "C. Limit screen time",
  "D. All of the Above"
]
correct_answer String Correct answer to a question interaction D. All of the Above
correct Boolean True/False if the viewer answered the question correctly TRUE
view_id Unique ID ID of the view ds4yh2sd-5df5-4by1-bccd-0be4c0dfd9b1
video_id Unique ID ID of the Video 0452e22e-5e15-4b51-bcc7-0be4c0df99b1
url String URL of the video https://myinteractive.video/ w/aVOfEGmGrZlG
viewer_id Unique ID ID of the viewer 8b5ce4b2-8bc6-4252-bdeb-a7304d7e028e
created_at DateTime When the interaction record was created in the Mindstamp database Sat, 1 Jan 2022 05:12:32 UTC +00:00
updated_at DateTime When the interaction record was last updated in the Mindstamp database Sat, 1 Jan 2022 05:15:24 UTC +00:00
group_id Unique ID ID of the group in which the video belongs to ac864070-9501-4f32-a361-075c89a2c339
variables JSON Object containing the variables used throughout the video {
  "name" : "John",
  "color" : "blue",
  "favorite_number" : 7
}
export_count Integer The number of times the interaction has been exported via a webhook 1
video_owner_id Unique ID User ID of the owner of the video 75d57cda-332b-400a-887e-0bed5f6ced99
response_time Integer Time in milliseconds it took to answer question 3401
internal_label String Unique JS identifier internal label of parent interaction city_question

πŸ“˜

Get in Touch

Need help or want to know more about using webhooks in Mindstamp? We're here for you! Contact [email protected] to learn more.