Default events are pre-defined user events that Insider One creates for your account. They are designed around the requirements of Insider One’s products and common user actions.
In addition to these defaults, you can also define custom events to track actions that are not included in the default list or to cover specific business use cases.
The default events are categorized as:
Pageview Events
Default Pageview Events are fired based on the page type a user is on at that time. For example, when a user visits the home page, the Homepage View event is triggered, along with the respective event parameters. The default pageview events and their event parameters are as follows:
Homepage View: Session ID, source, URL, device type, and referrer.
Listing Page View: Session ID, taxonomy, source, URL, device type, and referrer.
Product Detail Page View: Product ID, name, taxonomy, currency, unit price, unit sale price, quantity, product image URL, session ID, unit size, source, URL, device type, and referrer.
Cart Page View: Product ID, name, taxonomy, currency, unit price, unit sale price, quantity, unit size, product image URL, session ID, event group ID, category, source, URL, device type, and referrer.
Purchase (Confirmation Page View): Product ID, name, taxonomy, currency, unit price, unit sale price, quantity, product image URL, session ID, shipping cost, voucher name, voucher discount, promotion name, promotion discount, event group ID, quantity, unit size, color, source, URL, device type, and referrer.
Other Pageview: Session ID, source, URL, device type, and referrer.
Event | Event Parameter | Display Name | Definition | Source | Type |
|---|---|---|---|---|---|
Homepage View | sid | Session ID | The ID of the session where the event is fired | Web / Mobile | String |
source | Source | Source of the event (e.g., email, web, etc.) | Web | String | |
url | URL | URL of the page where the event is fired | Web | String | |
device_type | Device Type | The type of device used to fire the event | Web | String | |
referrer | Referrer | The referrer page of the page where the event is fired | Web | String | |
Listing Page View | sid | Session ID | The ID of the session where the event is fired | Web / Mobile | String |
ta | Taxonomy | Taxonomy of the page where the event is fired | Web / Mobile | Strings | |
source | Source | Source of the event (e.g., email, web, etc.) | Web | String | |
url | URL | URL of the page where the event is fired | Web | String | |
device_type | Device Type | The type of device used to fire the event | Web | String | |
referrer | Referrer | The referrer page of the page where the event is fired | Web | String | |
Product Detail Page View | pid | Product ID | Product ID | Web / Mobile | String |
na | Name | Product name | Web / Mobile | String | |
ta | Taxonomy | Taxonomy of the product | Web / Mobile | Strings | |
cu | Currency | Currency of the product | Web / Mobile | String | |
up | Unit Price | Unit price of the product | Web / Mobile | Number | |
usp | Unit Sale Price | Unit sale price of the product | Web / Mobile | Number | |
qu | Quantity | Quantity of the product | Web / Mobile | Number | |
piu | Product Image URL | Image URL of the product | Web / Mobile | String | |
sid | Session ID | The ID of the session where the event is fired | Web / Mobile | String | |
si | Unit Size | Unit size | Mobile | String | |
source | Source | Source of the event (e.g., email, web, etc.) | Web | String | |
url | URL | URL of the page where the event is fired | Web | String | |
device_type | Device Type | The type of device used to fire the event | Web | String | |
referrer | Referrer | The referrer page of the page where the event is fired | Web | String | |
Cart Page View | pid | Product ID | Product ID | Web / Mobile | String |
na | Name | Product name | Web / Mobile | String | |
ta | Taxonomy | Taxonomy of the product | Web / Mobile | Strings | |
cu | Currency | Currency of the product | Web / Mobile | String | |
up | Unit Price | Unit price of the product | Web / Mobile | Number | |
usp | Unit Sale Price | Unit sale price of the product | Web / Mobile | Number | |
piu | Product Image URL | Image URL of the product | Web / Mobile | String | |
qu | Quantity | Quantity of the product | Web / Mobile | Number | |
si | Unit Size | Unit Size | Mobile | String | |
sid | Session ID | The ID of the session where the event is fired | Web / Mobile | String | |
e_guid | Event Group ID | Group ID of the event | Web / Mobile | String | |
source | Source | Source of the event (e.g., email, web, etc.) | Web | String | |
url | URL | URL of the page where the event is fired | Web | String | |
device_type | Device Type | The type of device used to fire the event | Web | String | |
referrer | Referrer | The referrer page of the page where the event is fired | Web | String | |
Purchase (Confirmation Page View) | pid | Product ID | Product ID | Web / Mobile | String |
na | Name | Product name | Web / Mobile | String | |
ta | Taxonomy | Taxonomy of the product | Web / Mobile | Strings | |
cu | Currency | Currency of the product | Web / Mobile | String | |
up | Unit Price | Unit price of the product | Web / Mobile | Number | |
usp | Unit Sale Price | Unit sale price of the product | Web / Mobile | Number | |
piu | Product Image URL | Image URL of the product | Web / Mobile | String | |
sid | Session ID | The ID of the session where the event is fired | Web / Mobile | String | |
sc | Shipping Cost | Shipping cost of the product | Web / Mobile | Number | |
vn | Voucher Name | Voucher name | Web / Mobile | String | |
vd | Voucher Discount | The discount applied by the voucher | Web / Mobile | Number | |
pn | Promotion Name | Promotion name | Web / Mobile | String | |
pd | Promotion Discount | The discount applied by the promotion | Web / Mobile | Number | |
e_guid | Event Group ID | Group ID of the event | Web / Mobile | String | |
qu | Quantity | Quantity of the product | Web / Mobile | Number | |
si | Unit Size | Unit size | Mobile | String | |
co | Color | Color of the product | Mobile | String | |
source | Source | Source of the event (e.g., email, web, etc. | Web | String | |
url | URL | URL of the page where the event is fired | Web | String | |
device_type | Device Type | The type of device used to fire the event | Web | String | |
referrer | Referrer | The referrer page of the page where the event is fired | Web | String | |
Other Pageview | sid | Session ID | The ID of the session where the event is fired | Web / Mobile | String |
source | Source | Source of the event (e.g., email, web, etc. | Web | String | |
url | URL | URL of the page where the event is fired | Web | String | |
device_type | Device Type | The type of device used to fire the event | Web | String | |
referrer | Referrer | The referrer page of the page where the event is fired | Web | String |
User Events
Default User Events are fired based on user actions. For example, if a user joins a lead collection campaign, the Lead Collected event is triggered. If they clear their cart, the Cart Cleared event is fired. The default user events and their event parameters are as follows:
Cart Cleared: Session ID
Item Added to Cart: Product ID, name, taxonomy, currency, unit price, unit sale price, stock, color, size, product image URL, session ID, shipping cost, voucher name, voucher discount, promotion name, promotion discount, event group ID, source, quantity, URL, device type, and referrer.
Item Removed from Cart: Product ID, name, taxonomy, currency, unit price, unit sale price, stock, color, size, product image URL, session ID, shipping cost, voucher name, voucher discount, promotion name, promotion discount, event group ID, source, URL, device type, and referrer.
Signup Completed: No event parameter
Lead Collected: Campaign ID
Event | Event Parameter | Display Name | Definition | Source | Type |
|---|---|---|---|---|---|
Cart Cleared | sid | Session ID | The ID of the session where the event is fired | Web / Mobile | String |
Item Added to Cart | pid | Product ID | Product ID | Web / Mobile | String |
na | Name | Product name | Web / Mobile | String | |
ta | Taxonomy | Taxonomy of the product | Web / Mobile | Strings | |
cu | Currency | Currency of the product | Web / Mobile | String | |
up | Unit Price | Unit price of the product | Web / Mobile | Number | |
usp | Unit Sale Price | Unit sale price of the product | Web / Mobile | Number | |
st | Stock | Stock of the product | Web / Mobile | Number | |
co | Color | Color of the product | Web / Mobile | String | |
si | Size | Size of the product | Web / Mobile | String | |
piu | Product Image URL | Image URL of the product | Web / Mobile | String | |
sid | Session ID | The ID of the session where the event is fired | Web / Mobile | String | |
sc | Shipping Cost | Shipping cost of the product | Web / Mobile | Number | |
vn | Voucher Name | Voucher name | Web / Mobile | String | |
vd | Voucher Discount | Discount applied by the voucher | Web / Mobile | Number | |
pn | Promotion Name | Promotion name | Web / Mobile | String | |
pd | Promotion Discount | Discount applied by the voucher | Web / Mobile | Number | |
e_guid | Event Group ID | Group ID of the event | Web / Mobile | String | |
source | Source | Source of the event (e.g., email, web, etc.) | Web | String | |
qu | Quantity | Quantity of the product | Web | Number | |
url | URL | URL of the page where the event is fired | Web | String | |
device_type | Device Type | The type of device used to fire the event | Web | String | |
referrer | Referrer | The referrer page of the page where the event is fired | Web | String | |
Item Removed from Cart | pid | Product ID | Product ID | Web / Mobile | String |
na | Name | Product name | Web / Mobile | String | |
ta | Taxonomy | Taxonomy of the product | Web / Mobile | Strings | |
cu | Currency | Currency of the product | Web / Mobile | String | |
up | Unit Price | Unit price of the product | Web / Mobile | Number | |
usp | Unit Sale Price | Unit sale price of the product | Web / Mobile | Number | |
st | Stock | Stock of the product | Web / Mobile | Number | |
co | Color | Color of the product | Web / Mobile | String | |
si | Size | Size of the product | Web / Mobile | String | |
piu | Product Image URL | Image URL of the product | Web / Mobile | String | |
sid | Session ID | The ID of the session where the event is fired | Web / Mobile | String | |
sc | Shipping Cost | Shipping cost of the product | Web / Mobile | Number | |
vn | Voucher Name | Voucher name | Web / Mobile | String | |
vd | Voucher Discount | The discount applied by the voucher | Web / Mobile | Number | |
pn | Promotion Name | Promotion name | Web / Mobile | String | |
pd | Promotion Discount | The discount applied by the promotion | Web / Mobile | Number | |
e_guid | Event Group ID | Group ID of the event | Web / Mobile | String | |
source | Source | Source of the event (e.g., email, web, etc. | Web | String | |
url | URL | URL of the page where the event is fired | Web | String | |
device_type | Device Type | The type of device used to fire the event | Web | String | |
referrer | Referrer | The referrer page of the page where the event is fired | Web | String | |
Signup Completed | No event parameter | Web | - | ||
Lead Collected | campaign_id | Campaign ID | ID of the campaign that collected the lead | Web | Number |
Mobile App Events
Default Mobile App Events are triggered by Mobile App campaigns and are based on users' interactions with these campaigns. For example, when a user sees an InApp campaign, the InApp Seen event is fired. The default mobile app events and their event parameters are as follows:
InApp Seen: InApp ID, variant ID, dismiss type, Journey ID, and Journey Name.
Push Delivered: Camp ID, camp type, deep links, dry run, image URL, message, title, variant ID, Journey ID, and Journey Name.
Mobile Social Proof Seen: No event parameter
App Push Opened (push_session): Variant ID, camp type, camp ID, Journey ID, and Journey Name.
Mobile App Opened (session_start): No event parameter
Survey Result (survey_result): camp_id, variant_id, answer, crea, and question.
Event | Event Parameter | Display Name | Definition | Source | Type |
|---|---|---|---|---|---|
InApp Seen | inapp_id | Inapp ID | ID of the InApp seen by the user | Mobile | Number |
variant_id | Variant ID | Variant ID of the InApp seen by the user | Mobile | Number | |
dismiss_type | Dismiss Type | The dismiss action the user takes on an InApp campaign | Mobile | Number | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Mobile | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Mobile | String | |
Push Delivered | camp_id | Camp ID | ID of the push campaign delivered to the user | Mobile | Number |
camp_type | Camp Type | Type of the push campaign delivered to the user | Mobile | Number | |
deep_links | Deep Links | Deep links in the push campaign delivered to the user | Mobile | String | |
image_url | Image URL | Image URL of the push campaign delivered to the user | Mobile | String | |
message | Message | Message of the push campaign delivered to the user | Mobile | String | |
title | Title | Title of the push campaign delivered to the user | Mobile | String | |
variant_id | Variant ID | Variant ID of the push delivered to the user | Mobile | Number | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Mobile | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Mobile | String | |
App Push Opened | variant_id | Variant ID | Variant ID of the app push opened by the user | Mobile | Number |
camp_type | Camp Type | Type of the push campaign opened by the user | Mobile | Number | |
camp_id | Camp ID | ID of the push campaign seen by the user | Mobile | Number | |
journey_id | Journey ID | ID of the push campaign seen by the user | Mobile | String | |
journey_name | Journey Name | ID of the push campaign seen by the user | Mobile | String | |
Mobile App Opened | No event parameter | Mobile | - | ||
Survey Result | camp_id | Camp ID | ID of the push campaign delivered to the user | Mobile | String |
variant_id | Variant ID | ID of the variant of the survey that the user participated in | Mobile | String | |
answer | Answer | The user's response to the survey | Mobile | String | |
question | Question | The survey question to which the user responded | Mobile | String | |
Email Events
Default Email Events are fired by Email campaigns and are based on users' interactions with these campaigns. For example, if a user clicks a link in an email campaign, the Email Click event is triggered.
In a journey, when the Email channel triggers email events, the Journey ID and Journey Name are included as parameters in those events, such as the Email Delivered event. However, the Campaign ID, Campaign Name, and Variant ID are not included in these events, as they are not relevant to journey-triggered emails. In contrast, once a promotional bulk email campaign is launched and sent to users, the Campaign ID, Campaign Name, and Variant ID are included as event parameters.
The default email events and their event parameters are as follows:
Email Delivered: Email campaign ID, campaign name, variant ID, subject, user agent, IP address, Journey ID, and Journey Name.
Email Open: Email campaign ID, campaign name, variant ID, subject, user agent, IP address, machine open, human open, Journey ID, and Journey Name.
Email Click: Email campaign ID, campaign name, variant ID, subject, user agent, IP address, URL, URL offset index, URL offset type, Journey ID, and Journey Name.
Email Bounce: Email campaign ID, campaign name, variant ID, subject, IP address, reason, type, Journey ID, and Journey Name.
Email Block: Email campaign ID, campaign name, variant ID, subject, IP address, reason, type, Journey ID, and Journey Name.
Email Spam Report: Email campaign ID, campaign name, variant ID, subject, user agent, IP address, Journey ID, and Journey Name.
Email Group Unsubscribe: Email campaign ID, campaign name, variant ID, subject, user agent, IP address, group ID, Journey ID, and Journey Name.
Email Group Resubscribe: Email campaign ID, campaign name, variant ID, subject, user agent, IP address, group ID, Journey ID, and Journey Name.
Email Unsubscribe: Email campaign ID, campaign name, variant ID, subject, user agent, IP address, Journey ID, and Journey Name.
Email Resubscribe: Email campaign ID, campaign name, variant ID, subject, user agent, IP address, Journey ID, and Journey Name.
Event | Event Parameter | Display Name | Definition | Source | Type |
|---|---|---|---|---|---|
Email Delivered | email_campaign_id | Email Campaign ID | ID of the email campaign delivered to a user within a given time period | Number | |
campaign_name | Campaign Name | Name of the email campaign delivered to a user within a given time period | String | ||
variation_id | Variant ID | Variant ID of the email campaign delivered to a user within a given time period | Number | ||
subject | Subject | Subject of the delivered email campaign | String | ||
user_agent | User Agent | The user agent responsible for the event. This is usually a web browser. | String | ||
ip_address | IP address | IP address of the recipient who engaged with the email. This can help determine the recipient’s geographic location or the device used. | String | ||
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | String | ||
journey_name | Journey Name | Journey name when the campaign is a journey campaign | String | ||
Email Open | email_campaign_id | Email Campaign ID | ID of the email campaign opened by a user within a given time period | Number | |
campaign_name | Campaign Name | Name of the email campaign opened by a user within a given time period | String | ||
variation_id | Variant ID | Variant ID of the email campaign opened by a user within a given time period | Number | ||
subject | Subject | Subject of the opened email campaign | String | ||
user_agent | User Agent | The user agent responsible for the event. This is usually a web browser. | String | ||
ip_address | IP Address | IP address of the recipient who engaged with the email. This can help determine the recipient’s geographic location or the device they are using. | String | ||
machine_open | Machine Open | Indicates if the email is opened by a machine | Boolean | ||
human_open | Human Open | Indicates if the email is opened by a human | Boolean | ||
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | String | ||
journey_name | Journey Name | Journey name when the campaign is a journey campaign | String | ||
Email Click | email_campaign_id | Email Campaign ID | ID of the email campaign clicked by a user within a given time period | Number | |
campaign_name | Campaign Name | Name of the email campaign clicked by a user within a given time period | String | ||
variation_id | Variant ID | Variant ID of the email campaign clicked by a user within a given time period | Number | ||
subject | Subject | Subject of the clicked email campaign | String | ||
user_agent | User Agent | The user agent responsible for the event. This is usually a web browser. | String | ||
ip_address | IP Address | IP address of the recipient who engaged with the email. This can help determine the recipient’s geographic location or the device used. | String | ||
url | URL | URL of the email campaign clicked by a user within a given time period | String | ||
url_offset_index | URL Offset Index | The index number of the same link in an email. This tells you which of the identical links was clicked. Links are indexed beginning at 0. | Number | ||
url_offset_type | URL Offset Type | The type of link can be either text, HTML, or a header. `type` indicates the type of link that was clicked. | String | ||
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | String | ||
journey_name | Journey Name | Journey name when the campaign is a journey campaign | String | ||
Email Bounce | email_campaign_id | Email Campaign ID | ID of the bounced email campaign | Number | |
campaign_name | Campaign Name | Name of the bounced email campaign | String | ||
variation_id | Variant ID | Variant ID of the bounced email campaign | Number | ||
subject | Subject | Subject of the bounced email campaign | String | ||
ip_address | IP Address | IP address of the recipient who engaged with the email. This can help determine the recipient’s geographic location or the device used. | String | ||
reason | Reason | The reason why the email campaign is bounced | String | ||
type | Type | Type of the email bounce | String | ||
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | String | ||
journey_name | Journey Name | Journey name when the campaign is a journey campaign | String | ||
Email Block | email_campaign_id | Email Campaign ID | ID of the campaign whose recipient's address is blocked | Number | |
campaign_name | Campaign Name | Name of the campaign whose recipient's address is blocked | String | ||
variation_id | Variant ID | Variant ID of the campaign whose recipient's address is blocked | Number | ||
subject | Subject | Subject of the blocked email campaign | String | ||
ip_address | IP Address | IP address of the recipient who engaged with the email. This can help determine the recipient’s geographic location or the device used. | String | ||
reason | Reason | The reason why the email campaign is blocked | String | ||
type | Type | Type of the email block | String | ||
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | String | ||
journey_name | Journey Name | Journey name when the campaign is a journey campaign | String | ||
Email Spam Report | email_campaign_id | Email Campaign ID | ID of the email campaign marked as spam | Number | |
campaign_name | Campaign Name | Name of the campaign marked as spam | String | ||
variation_id | Variant ID | Variant ID of the campaign marked as spam | Number | ||
subject | Subject | Subject of the email campaign reported as spam | String | ||
user_agent | User Agent | The user agent responsible for the event. This is usually a web browser. | String | ||
ip_address | IP Address | IP address of the recipient who engaged with the email. This can help determine the recipient’s geographic location or the device used. | String | ||
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | String | ||
journey_name | Journey Name | Journey name when the campaign is a journey campaign | String | ||
Email Group Unsubscribe | email_campaign_id | Email Campaign ID | ID of the email campaign whose category users partially unsubscribe from | Number | |
campaign_name | Campaign Name | Name of the email campaign whose category users partially unsubscribe from | String | ||
variation_id | Variant ID | Variant ID of the email campaign whose users partially unsubscribe from | Number | ||
subject | Subject | Subject of the email campaign group unsubscribed from | String | ||
user_agent | User Agent | The user agent responsible for the event. This is usually a web browser. | String | ||
ip_address | IP Address | IP address of the recipient who engaged with the email. This can help determine the recipient’s geographic location or the device used. | String | ||
group_id | Group ID | Group ID of the email campaign unsubscribed from | Number | ||
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | String | ||
journey_name | Journey Name | Journey name when the campaign is a journey campaign | String | ||
Email Group Resubscribe | email_campaign_id | Email Campaign ID | ID of the email campaign whose category users resubscribe from | Number | |
campaign_name | Campaign Name | Name of the email campaign whose category users resubscribe from | String | ||
variation_id | Variant ID | Variant ID of the email campaign whose category users partially resubscribed from | Number | ||
subject | Subject | Subject of the email campaign group resubscribed from | String | ||
user_agent | User Agent | The user agent responsible for the event. This is usually a web browser. | String | ||
ip_address | IP Address | IP address of the recipient who engaged with the email. This can help determine the recipient’s geographic location or the device used. | String | ||
group_id | Group ID | Group ID of the email campaign resubscribed from | Number | ||
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | String | ||
journey_name | Journey Name | Journey name when the campaign is a journey campaign | String | ||
Email Unsubscribe | email_campaign_id | Email Campaign ID | ID of the email campaign marked as global unsubscribe by users | Number | |
campaign_name | Campaign Name | Name of the email campaign marked as a global unsubscribe by users | String | ||
variation_id | Variant ID | Variant ID of the email campaign marked as a global unsubscribe by users | Number | ||
subject | Subject | Subject of the email campaign unsubscribed from | String | ||
user_agent | User Agent | The user agent responsible for the event. This is usually a web browser. | String | ||
ip_address | IP Address | IP address of the recipient who engaged with the email. This can help determine the recipient’s geographic location or the device used. | String | ||
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | String | ||
journey_name | Journey Name | Journey name when the campaign is a journey campaign | String | ||
Email Resubscribe | email_campaign_id | Email Campaign ID | ID of the email campaign marked as resubscribed by users | Number | |
campaign_name | Campaign Name | Name of the email campaign marked as resubscribed by users | String | ||
variation_id | Variant ID | Variant ID of the email campaign marked as resubscribed by users | Number | ||
subject | Subject | Subject of the email campaign resubscribed from | String | ||
user_agent | User Agent | The user agent responsible for the event. This is usually a web browser. | String | ||
ip_address | IP Address | IP address of the recipient who engaged with the email. This can help determine the recipient’s geographic location or the device used. | String | ||
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | String | ||
journey_name | Journey Name | Journey name when the campaign is a journey campaign | String |
Architect Events
Default Architect Events are fired by the Architect journeys and are based on users' interactions with these campaigns. For example, if a user enters a journey, the Journey Enter event is triggered. The default Architect events are as follows:
Journey Enter: Journey ID, name, and reason.
Journey Exit: Journey ID, name, and reason.
Journey Product Action: Action code, campaign ID, journey ID, and channel code.
Journey Enter Reasons
The following can be the value for the reason parameter:
Unified
The same user enters the journey as two different user profiles, gets unified while still in the journey, and continues the journey as one unified user.
User A becomes eligible to enter a journey and then gets unified with user B. In this case, user A becomes user B in Insider One's Unified Customer Database, which means that user B enters the journey as it is unified.
Natural: The user was eligible to enter the journey naturally.
Journey Exit Reasons
The following can be the value for the reason parameter:
Exited: The user fulfilled any of the Exit Criteria and exited the journey.
Completed: The user reached the end of a path and completed the journey.
Dropped: The user was unreachable from the channel element and was dropped from the journey.
Event | Event Parameter | Display Name | Definition | Source | Type |
|---|---|---|---|---|---|
Journey Enter | journey_id | Journey ID | ID of the journey users entered. Used in the Events segment and Exit Criteria | Misc. | Number |
name | Name | Name of the journey users entered. Used in the Events segment and Exit Criteria | Misc. | String | |
reason | Reason | The reason for the Journey Enter event. The values can be natural or unified. | Misc. | String | |
Journey Exit | journey_id | Journey ID | ID of the journey users exited. Used to connect journeys and allow users to start a journey when they exit another one. | Misc. | Number |
name | Name | Name of the journey users exited. Used to connect journeys and allow users to start a journey when they exit another one. | Misc. | String | |
reason | Reason | The reason for the Journey Exit event. The values can be exited, completed, or dropped. | Misc. | String | |
event_code | Event Code | A mix of channel code and campaign ID to identify the channel element that the user exited or dropped from. It is in the format of “[Channel Code]:[Campaign ID]”. Campaign ID can be found in the inner pages of channel elements. For further information, refer to How to Export Journey User Data. | Misc. | String |
Web Push Events
Default Web Push Events are fired by the Web Push campaigns and are based on users' interactions with these campaigns. For example, if a user clicks a Web Push notification, the Web Push Click event is triggered. The default Web Push events and their event parameters are as follows:
Web Push View: Variant ID, Campaign ID, and Campaign Name
Web Push Click: Variant ID, Campaign ID, and Campaign Name
Event | Event Parameter | Display Name | Definition | Source | Type |
|---|---|---|---|---|---|
Web Push View | variant_id | Variant ID | Variant ID of the web push notification viewed by a user | Web | Number |
camp_id | Campaign ID | Campaign ID of the web push notification viewed by a user | Web | Number | |
camp_name | Campaign Name | Campaign Name of the web push notification viewed by a user | Web | String | |
Web Push Click | variant_id | Variant ID | Variant ID of the web push notification clicked by a user | Web | Number |
camp_id | Campaign ID | Campaign ID of the web push notification clicked by a user | Web | Number | |
camp_name | Campaign Name | Campaign Name of the web push notification clicked by a user | Web | String |
WhatsApp Events
Default WhatsApp Events are fired by the WhatsApp campaigns and are based on users' interactions with these campaigns. For example, if a user replies to a WhatsApp message with the second button, the WhatsApp Reply Second Button event is triggered.
The default WhatsApp events and their event parameters are as follows:
WhatsApp Click: Variant ID, Campaign Name, Journey ID, and Journey Name.
WhatsApp Delivered: Variant ID, Campaign Name, Journey ID, and Journey Name.
WhatsApp Reply: Variant ID, Campaign Name, Journey ID, and Journey Name.
WhatsApp Reply First Button: Variant ID, Campaign Name, Journey ID, and Journey Name.
WhatsApp Reply Second Button: Variant ID, Campaign Name, Journey ID, and Journey Name.
WhatsApp Reply Third Button: Variant ID, Campaign Name, Journey ID, and Journey Name.
WhatsApp Reply Other Reply: Variant ID, Campaign Name, Journey ID, and Journey Name.
WhatsApp Unsubscribe: Variant ID, Campaign Name, Journey ID, and Journey Name.
If only the identifier is used and the user unsubscribes after receiving the latest journey message, the journey parameters are recorded.
WhatsApp Read: Variant ID, Journey ID, and Journey Name.
Event | Event Parameter | Display Name | Definition | Source | Type |
|---|---|---|---|---|---|
WhatsApp Click | variant_id | Variant ID | Variant ID of the WhatsApp campaign clicked by a user | Web | Integer |
campaing_name | Campaign Name | Campaign name of the WhatsApp campaign clicked by a user | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String | |
WhatsApp Delivered | variant_id | Variant ID | Variant ID of the WhatsApp campaign delivered to a user | Web | Integer |
campaing_name | Campaign Name | Campaign name of the WhatsApp campaign delivered to a user | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String | |
WhatsApp Reply | variant_id | Variant ID | Variant ID of the WhatsApp campaign replied to by a user | Web | Integer |
campaing_name | Campaign Name | Campaign name of the WhatsApp campaign replied to by a user | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String | |
WhatsApp Reply First Button | variant_id | Variant ID | Variant ID of the WhatsApp message's first button clicked by the user | Web | Integer |
campaing_name | Campaign Name | Campaign name of the WhatsApp message whose first button clicked by the user | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String | |
WhatsApp Reply Second Button | variant_id | Variant ID | Variant ID of the WhatsApp message's second button clicked by the user | Web | Integer |
campaing_name | Campaign Name | Campaign name of the WhatsApp message whose second button clicked by the user | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String | |
WhatsApp Reply Third Button | variant_id | Variant ID | Variant ID of the WhatsApp message's third button clicked by the user | Web | Integer |
campaing_name | Campaign Name | Campaign name of the WhatsApp message whose third button clicked by the user | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String | |
WhatsApp Reply Other Reply | variant_id | Variant ID | Variant ID of the WhatsApp campaign replied to by a user with the other option | Web | Integer |
campaing_name | Campaign Name | Campaign name of the WhatsApp campaign replied to by a user with the other option | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String | |
WhatsApp Unsubscribe | variant_id | Variant ID | Variant ID of the WhatsApp campaign unsubscribed by a user | Web | Integer |
campaing_name | Campaign Name | Campaign name of the WhatsApp campaign unsubscribed by a user | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String | |
WhatsApp Read | variant_id | Variant ID | Variant ID of the WhatsApp campaign read by a user | Web | Integer |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String |
SMS Events
Default SMS Events are fired by the SMS campaigns and are based on users' interactions with these campaigns. For example, if a user clicks a URL in the SMS message, the SMS Click event is triggered. The default SMS events and their event parameters are as follows:
SMS Click: Variant ID, Campaign Name, Journey ID, and Journey Name.
SMS Delivered: Variant ID, Campaign Name, Journey ID, and Journey Name.
SMS Unsubscribe: Variant ID, Campaign Name, Journey ID, and Journey Name.
SMS Subscribe: Variant ID, Campaign Name, Journey ID, and Journey Name.
SMS Undelivered: Variant ID, Campaign Name, Reason Type, Journey ID, and Journey Name.
SMS Reply: Variant ID, Campaign Name, Reason Type, Journey ID, and Journey Name.
SMS Campaigns: Variant ID
SMS Drop: Variant ID, Campaign Name, Reason Type, Journey ID, and Journey Name.
Event | Event Parameter | Display Name | Definition | Source | Type |
|---|---|---|---|---|---|
SMS Click | variant_id | Variant ID | Variant ID of an SMS clicked by a user | Web | Integer |
campaing_name | Campaign Name | Campaign name of an SMS clicked by a user | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String | |
SMS Delivered | variant_id | Variant ID | Variant ID of an SMS delivered to a user | Web | Integer |
campaing_name | Campaign Name | Campaign name of an SMS delivered to a user | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String | |
SMS Unsubscribe | variant_id | Variant ID | Variant ID of an SMS unsubscribed by a user | Web | Integer |
campaing_name | Campaign Name | Campaign name of an SMS unsubscribed by a user | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String | |
SMS Subscribe | variant_id | Variant ID | Variant ID of an SMS subscribed to by a user | Web | Integer |
campaing_name | Campaign Name | Campaign name of an SMS subscribed to by a user | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String | |
SMS Undelivered | variant_id | Variant ID | Variant ID of an SMS undelivered to a user | Web | Integer |
campaing_name | Campaign Name | Campaign name of an SMS undelivered to a user | Web | String | |
reason_type | Reason Type | Reason why an SMS undelivered to a user | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String | |
SMS Reply | variant_id | Variant ID | Variant ID of an SMS clicked by a user | Web | Integer |
campaing_name | Campaign Name | Campaign name of an SMS clicked by a user | Web | String | |
reason_type | Reason Type | Reason why an SMS undelivered to a user | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String | |
SMS Campaigns | variant_id | Variant ID | Variant ID of an SMS campaign | Web | Integer |
SMS Drop | variant_id | Variant ID | Variant ID of an SMS clicked by a user | Web | Integer |
campaing_name | Campaign Name | Campaign name of an SMS clicked by a user | Web | String | |
reason_type | Reason Type | Reason why an SMS undelivered to a user | Web | String | |
journey_id | Journey ID | Journey ID when the campaign is a journey campaign | Web | String | |
journey_name | Journey Name | Journey name when the campaign is a journey campaign | Web | String |