Docs

Built-in event catalog

Events the SDK emits itself or through its helpers. Names and props are stable; the CPI preset maps 1:1 onto them, so data stays comparable with the cpi-website2 engine. Props are trimmed in the browser and validated again on the server: an event with a missing or invalid required prop is dropped. Your own events are documented in Custom events and presets.

EventPresetPropsOnce per pageviewSession flag
clickcorekind: internal, external, anchor, tel, mailto, whatsapp, messaging, download, button, form, other; tag: string ≤ 20, pattern ^[a-z][a-z0-9-]{0,19}$; label: string ≤ 80, label (optional); href: string ≤ 200, pattern ^(?:\/[A-Za-z0-9/._~:-]{0,199}|[a-z0-9.-]{1,100})$ (optional); section: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$ (optional); y: int 0–100 (optional)no–
form_startformsform: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$no–
form_submitformsform: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$noform_submit
form_abandonformsform: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$; fields: int 0–200 (optional); ms: int 0–86400000 (optional)no–
video_startvideovideo: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$; n: int 0–9; format: landscape, portrait, unknownno–
video_completevideovideo: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$; n: int 0–9no–
quiz_viewquizvariant: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$ (optional)yesquiz_viewed
quiz_answerquizvariant: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$; q: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$; value: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$no–
quiz_contactquizvariant: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$ (optional)yesquiz_contact
quiz_submitquizvariant: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$ (optional)yesquiz_submitted
cta_clickctalabel: string ≤ 80, label (optional); section: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$ (optional)nocta_click
whatsapp_clickmessagingsection: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$ (optional)nowhatsapp
messaging_clickmessagingapp: telegram, signal, messenger, viber, line, wechat, sms, skype, threema; section: string ≤ 40, pattern ^[A-Za-z0-9_.:-]{1,40}$ (optional)no–
calculator_usedcalculator–yescalculator
bookingbookingvia: string ≤ 20, pattern ^[a-z][a-z0-9_]{0,19}$yesbooked
funnel_stepfunnelfunnel: string ≤ 40, pattern ^[a-z][a-z0-9_]{0,39}$; step: string ≤ 40, pattern ^[a-z][a-z0-9_]{0,39}$no–

Labels

EventEnglishDeutsch
clickClickKlick
form_startForm startedFormular begonnen
form_submitForm submittedFormular abgeschickt
form_abandonForm abandonedFormular abgebrochen
video_startVideo startedVideo gestartet
video_completeVideo end reachedVideo-Ende erreicht
quiz_viewQuiz viewedQuiz gesehen
quiz_answerQuiz answerQuiz-Antwort
quiz_contactQuiz contact stepQuiz-Kontaktschritt
quiz_submitQuiz submittedQuiz abgeschickt
cta_clickCTA clickedCTA geklickt
whatsapp_clickWhatsApp clickedWhatsApp geklickt
messaging_clickMessenger clickedMessenger geklickt
calculator_usedCalculator usedRechner genutzt
bookingMeeting bookedTermin gebucht
funnel_stepFunnel stepTrichterschritt

Delivery rules

  • Events marked once per pageview are dropped when repeated on the same pageview.
  • Repeats within one second are de-duplicated by name (cta_click, whatsapp_click, messaging_click) or by name and props (everything else except click).
  • form_submit, video_complete, quiz_submit, whatsapp_click, messaging_click and booking are sent immediately because the page may unload.