Click Interaction
Fire the click event to track meaningful click interactions on your website — buttons, links, downloads, video controls, social-share icons, and any other clickable element that signals user engagement. This is a generic interaction event for any click that doesn't have a more specific event (click_to_phone, click_to_email, click_to_whatsapp are auto-tracked separately).
Fire the event once per click, with event.properties capturing what was clicked. The richer the properties (element name, action, target, position), the more useful the data for analytics segmentation.
This event is the DATA Reshape equivalent of the standard click event in every major advertising and analytics platform — push it once and Reshape fans it out to every connected destination with the correct platform-specific name and field mapping, so you do not need to fire gtag, fbq, ttq or other tracking function calls in parallel.
- Google Analytics 4 — no dedicated standard event; mapped as a custom
clickevent. Properties become custom event params. - Google Ads — typically not used as a conversion; can be configured for engagement-based audiences.
- Meta Pixel / Meta Conversions API — no dedicated standard event; Reshape can send a custom CamelCase event
Clickwhen connected. - TikTok Pixel / TikTok Events API — no dedicated standard event; Reshape can send a custom CamelCase event
Clickwhen connected. - Other connected destinations — mapped automatically based on each destination's native schema.
A single Reshape event can produce one or more native events per destination, with different characteristics depending on each website's destination configuration (active pixels, server endpoints, event-mapping rules).
Complete Reference
The click event accepts the following objects and fields.
event object required
name string required
Use only static value click for event.name.
name: "click"
value number required
Typically 0 for generic clicks. Use a non-zero value for engagement-based scoring (e.g. download click might be worth more than a button click).
value: 0
currency string required
Currency code, ISO 4217 three-letter format.
currency: "USD"
id string
Optional click event identifier.
id: "click_abc123"
properties object recommended
Custom properties describing what was clicked — element_name, element_action, element_target, element_position, etc. The richer the properties, the more useful for analytics segmentation.
context object
url string required-if-applicable
Collected automatically for standard websites. Required only for SPA applications where URL changes don't trigger automatic page context updates.
url:"https://example.com/products/prod_abc123?utm_source=example"
URL Parameter Sensitivity: Be mindful of sensitive information in URLs. Query parameters may contain personal identifiers, session tokens, or private information that should be handled according to privacy regulations.
page_type string recommended
Type of page (product, home ...)
page_type: "product"
environment string recommended
Allowed values: prod, dev
environment: "prod"
user object recommended
id string recommended
Unique customer identifier in your system.
id: "cust_abc123"
email string recommended
Customer email address in plaintext. Do not send pre-hashed values — DATA Reshape automatically normalizes and hashes before sending to destinations.
email: "[email protected]"
phone string recommended
Customer phone number in E.164 format (plaintext). Do not send pre-hashed values — DATA Reshape automatically normalizes and hashes before sending to destinations.
phone: "+10000000000"
first_name string recommended
Customer first name
first_name: "Example First Name"
last_name string recommended
Customer last name
last_name: "Example Last Name"
country string
Country name or ISO country code
country: "US"
region string recommended
State, province, or region name
region: "Example Region"
city string recommended
City or locality name
city: "Example City"
street string
Street address including number
street: "123 Sample Street"
postal_code string
Postal code or ZIP code
postal_code: "00000"
orders_total_number number recommended
Cumulative number of orders placed by this user
orders_total_number: 5
orders_canceled_number number recommended
Cumulative number of orders placed and canceled by this user
orders_canceled_number: 0
orders_total_value number recommended
Cumulative lifetime user orders value (decimal format: 2500.50)
orders_total_value: 1234.99
orders_refunded_value number recommended
Cumulative lifetime user orders value canceled (decimal format: 2500.50)
orders_refunded_value: 250.99
predicted_value number
Predicted lifetime value of a customer for your business
predicted_value: 100.99
created_at number recommended
Timestamp in milliseconds since Unix epoch representing the first time the user was recorded
created_at: 1754926521690
properties object recommended
Custom Customer Properties Examples
Use the properties object to store custom user attributes, with property names defined by each business as needed, that enable advanced segmentation, personalization, and analytics across your marketing campaigns.
- E-commerce Customer
- B2B Lead/Customer
- Subscription Service
- Content Platform
properties: {
customer_type: "returning",
membership_level: "platinum",
preferred_category: ["electronics", "fashion"],
last_purchase_date: "2024-12-15",
average_order_value: "350.00",
payment_method_preference: "card",
registration_date: "2023-06-15"
}
properties: {
company_size: "enterprise",
industry: "fintech",
job_title: "marketing_director",
decision_maker: "true",
budget_range: "50000-100000",
lead_source: ["linkedin", "webinar"],
qualification_status: "qualified",
sales_stage: "proposal"
}
properties: {
subscription_tier: "premium",
billing_cycle: "annual",
feature_usage: ["analytics", "reporting", "api"],
trial_user: "false",
renewal_date: "2025-06-30",
support_level: "priority",
usage_frequency: "daily"
}
properties: {
content_preferences: ["technology", "business"],
engagement_level: "high",
newsletter_subscriber: "true",
social_media_follower: "true",
content_consumption: "premium",
device_preference: ["mobile", "desktop"],
timezone: "Example/Timezone"
}
Examples
The examples below show how to push click for five common element types — Button, Link, Download, Video and Social Share — plus an additional Minimal tab with only the required fields.
- Button
- Link
- Download
- Video
- Social Share
- Minimal
window.reshape = window.reshape || [];
reshape.push({
"event": {
"name": "click",
"value": 0,
"currency": "USD",
"properties": {
"element_type": "button",
"element_name": "request_demo",
"element_action": "submit_intent",
"element_position": "hero_section",
"element_label": "Request a Demo"
}
},
"context": {
"url": "https://example.com/",
"page_type": "home",
"environment": "prod"
}
});
window.reshape = window.reshape || [];
reshape.push({
"event": {
"name": "click",
"value": 0,
"currency": "USD",
"properties": {
"element_type": "link",
"element_name": "footer_pricing",
"element_action": "internal_navigation",
"element_target": "/pricing",
"element_position": "footer"
}
},
"context": {
"url": "https://example.com/",
"page_type": "home",
"environment": "prod"
}
});
window.reshape = window.reshape || [];
reshape.push({
"event": {
"name": "click",
"value": 5.00,
"currency": "USD",
"properties": {
"element_type": "download",
"element_name": "pricing_guide_pdf",
"element_action": "download",
"element_target": "/downloads/pricing-guide.pdf",
"file_type": "pdf",
"file_size_kb": 1240
}
},
"context": {
"url": "https://example.com/pricing",
"page_type": "pricing",
"environment": "prod"
}
});
window.reshape = window.reshape || [];
reshape.push({
"event": {
"name": "click",
"value": 0,
"currency": "USD",
"properties": {
"element_type": "video",
"element_name": "product_demo_video",
"element_action": "play",
"video_title": "Example Product Demo",
"video_provider": "youtube",
"video_duration_seconds": 120
}
},
"context": {
"url": "https://example.com/product",
"page_type": "product",
"environment": "prod"
}
});
window.reshape = window.reshape || [];
reshape.push({
"event": {
"name": "click",
"value": 0,
"currency": "USD",
"properties": {
"element_type": "social_share",
"element_name": "share_button",
"element_action": "share",
"share_platform": "linkedin",
"shared_url": "https://example.com/blog/example-post"
}
},
"context": {
"url": "https://example.com/blog/example-post",
"page_type": "blog_post",
"environment": "prod"
}
});
window.reshape = window.reshape || [];
reshape.push({
"event": {
"name": "click",
"value": 0,
"currency": "USD",
"properties": {
"element_name": "example_button"
}
}
});
Custom properties (event.properties, user.properties, products[*].properties) are fully processed server-side. On browser-side pixels and tags, only a subset may be available. Server-side processing can also enrich the outgoing payload with additional parameters derived from context and data quality.
Best Practices
- Be selective — track only meaningful clicks that have analytic or attribution value. Tracking every click pollutes data and inflates event counts.
- Use consistent
element_typevalues —button,link,download,video,social_share,image,icon, etc. Consistent typing produces clean reports across destinations. - Capture
element_name— a stable, semantic name for the clicked element (e.g.request_demo,footer_pricing,pricing_guide_pdf). This is what destinations use for segmentation. - Use
valuefor engagement scoring — assign higher values to clicks that signal stronger intent (downloads, video plays > generic link clicks). - For phone/email/WhatsApp clicks, use the dedicated auto-tracked events —
click_to_phone,click_to_email,click_to_whatsappare fired automatically by DATA Reshape and do not need manual pushing.