> For the complete documentation index, see [llms.txt](https://docs.hackle.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hackle.io/en/imweb/events.md).

# Imweb Event Description

## Imweb Event Description

{% hint style="info" %}
This document describes the identifiers, User Properties, and Events that are automatically collected during Imweb integration.

* Identifier information depending on whether the store visitor is logged in
* User Property information set based on store member information
* Events that are automatically collected for store user actions
  {% endhint %}

### Identifiers

<table><thead><tr><th width="154.6171875">Identifier</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>userId</code></td><td>Users who are logged in to the store have this identifier.<br>This is the same value as the Imweb member ID (<code>memberUid</code>), and is usually in email format.</td><td><code>test_member@imweb.me</code></td></tr><tr><td><code>deviceId</code></td><td>Users who are not logged in to the store only have this identifier.</td><td><code>5c5350475b5c555747594745063e.1774861304941</code></td></tr></tbody></table>

{% hint style="info" %}
For more details, see Managing User Identifiers.
{% endhint %}

### User Properties

#### Properties Collected on Page Access

Collects the values as of the moment the user accessed the store page.

{% hint style="warning" %}
These property values are from the last time the user accessed the store.
{% endhint %}

<details>

<summary>View User Properties</summary>

<table data-full-width="true"><thead><tr><th width="280">Property Key</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>__hackle__isimweb</code></td><td>A value indicating that the user is an Imweb-integrated user. It is always <code>true</code>.</td><td><code>true</code></td></tr><tr><td><code>unit_code</code></td><td>Imweb unit code</td><td><code>u2026092184d08946e2c63</code></td></tr><tr><td><code>member_id</code></td><td>Member ID (same as the <code>userId</code> value)</td><td><code>test_member@imweb.me</code></td></tr><tr><td><code>last_visit_page</code></td><td>Name of the page visited immediately before</td><td><code>mypage</code></td></tr><tr><td><code>last_visit_date</code></td><td>Last visit date (yyyyMMdd format)</td><td><code>20260930</code></td></tr><tr><td><code>last_login_date</code></td><td>Last login date (yyyyMMdd format)</td><td><code>20261001</code></td></tr></tbody></table>

</details>

{% hint style="info" %}
**Is there a property that is not being collected?**

All information is collected based on values provided by Imweb.

If User Properties are not being collected, check whether the sign-up fields of your store are set as **required**.
{% endhint %}

#### Properties Updated in Real Time

Properties that are collected immediately after a user performs a specific action.

<details>

<summary>View User Properties</summary>

<table data-full-width="true"><thead><tr><th width="280">Property Key</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>join_datetime</code></td><td>Sign-up time (yyyy-MM-dd HH:mm:ss format)</td><td><code>2026-09-03 10:22:11</code></td></tr><tr><td><code>join_date</code></td><td>Sign-up date (yyyy-MM-dd format)</td><td><code>2026-09-03</code></td></tr><tr><td><code>join_date_num</code></td><td>Sign-up date (yyyyMMdd format)</td><td><code>20260903</code></td></tr><tr><td><code>join_month_day</code></td><td>Sign-up month and day (MM-dd format)</td><td><code>09-03</code></td></tr><tr><td><code>join_year</code></td><td>Sign-up year (yyyy format)</td><td><code>2026</code></td></tr><tr><td><code>name</code></td><td>Member name</td><td><code>홍길동</code></td></tr><tr><td><code>email</code></td><td>Email address<br>Collected at the time of sign-up, and is not updated even if the member information changes afterward.</td><td><code>test_member@imweb.me</code></td></tr><tr><td><code>gender</code></td><td>Gender (as provided by Imweb)<br>Collected at the time of sign-up, and is not updated even if the member information changes afterward.</td><td>-</td></tr><tr><td><code>birth_date</code></td><td>Date of birth (yyyy-MM-dd format)</td><td><code>1990-01-01</code></td></tr><tr><td><code>birth_date_num</code></td><td>Date of birth (yyyyMMdd format)</td><td><code>19900101</code></td></tr><tr><td><code>birth_month_day</code></td><td>Birthday month and day (MM-dd format)</td><td><code>01-01</code></td></tr><tr><td><code>birth_year</code></td><td>Year of birth (yyyy format)</td><td><code>1990</code></td></tr><tr><td>전화번호</td><td>Member phone number. It is converted to E.164 format and stored as a phone number property.<br>It is deleted when the member withdraws, or when the phone number is empty or cannot be converted.</td><td><code>+821012345678</code></td></tr><tr><td><code>sms</code></td><td>Whether the member consented to receive SMS</td><td><code>true</code></td></tr><tr><td><code>third_party_agree</code></td><td>Whether the member consented to third-party provision</td><td><code>true</code></td></tr><tr><td><code>grade_code</code></td><td>Member grade code</td><td><code>g20250124563854a652d54</code></td></tr><tr><td><code>available_point</code></td><td>Available reward points</td><td><code>"9000"</code></td></tr><tr><td><code>cart_last_added_date</code></td><td>Date a product was last added to the cart (yyyy-MM-dd format)</td><td><code>2026-09-03</code></td></tr><tr><td><code>cart_last_added_date_num</code></td><td>Date a product was last added to the cart (yyyyMMdd format)</td><td><code>20260903</code></td></tr></tbody></table>

</details>

#### Properties Updated Periodically

{% hint style="warning" %}
The Hackle server periodically collects information to update User Properties. To enable this collection, please contact the Hackle team separately.
{% endhint %}

<details>

<summary>View User Properties</summary>

<table data-full-width="true"><thead><tr><th width="280">Property Key</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><code>order_gross_first_date</code></td><td>First order date (yyyy-MM-dd format)<br>Cancellations and returns are not reflected.</td><td><code>2025-03-11</code></td></tr><tr><td><code>order_gross_last_date</code></td><td>Last order date (yyyy-MM-dd format)<br>Cancellations and returns are not reflected.</td><td><code>2026-09-07</code></td></tr><tr><td><code>order_gross_total_count</code></td><td>Cumulative number of orders<br>Cancellations and returns are not reflected.</td><td><code>7</code></td></tr><tr><td><code>order_gross_total_price_amount</code></td><td>Cumulative order amount<br>Cancellations and returns are not reflected.</td><td><code>312000</code></td></tr><tr><td><code>order_gross_total_payment_amount</code></td><td>Cumulative actual payment amount<br>Cancellations and returns are not reflected.</td><td><code>289000</code></td></tr><tr><td><code>cp_{couponCode}_issued_date</code></td><td>Issue date per coupon (yyyy-MM-dd format)</td><td><code>2026-09-01</code></td></tr><tr><td><code>cp_{couponCode}_expire_date</code></td><td>Expiration date per coupon (yyyy-MM-dd format)<br>Not collected for coupons without an expiration date.</td><td><code>2026-09-30</code></td></tr><tr><td><code>cp_{couponCode}_used_date</code></td><td>Usage date per coupon (yyyy-MM-dd format)<br>Not collected for unused coupons.</td><td><code>2026-09-07</code></td></tr><tr><td><code>cp_{couponCode}_use_flag</code></td><td>Whether each coupon has been used</td><td><code>false</code></td></tr></tbody></table>

</details>

### Events

Events that Hackle automatically collects for user actions in the store during Imweb integration. They are organized by the categories below.

{% hint style="info" %}
This explains the information shown for each Event.

* **Collection Timing** — `Real-time` means collected immediately when the user action occurs, and `Periodic (batch)` means the Hackle server collects and publishes it periodically.
* **In-App Message** — Events marked `Available` can be used as the start Event of an In-App Message.
* **Non-member Sending** — Events marked `Supported` allow sending Kakao/text messages to non-member store visitors in Event-based Campaigns (Kakao/Text, User Journey). To use this feature, please contact the Hackle team.

You can check the **Event Properties** of each Event by expanding `View Event Properties`.
{% endhint %}

{% hint style="info" %}
**Properties collected with all Events**

* Events collected from the browser are collected together with `is_login` (whether logged in), `is_mobile` (whether on mobile), and `triggeredBy` (fixed to `SDK`).
* Events collected from the Imweb server are collected together with `unit_code` (unit code) and `member_id` (member ID).
* Properties with empty values (`null`, empty string, empty array) are not collected.
  {% endhint %}

{% hint style="warning" %}
Due to structural constraints of Imweb stores, some Events cannot be used as the start Event of an In-App Message.

* Events that occur on the Imweb server rather than in the browser
* Events after which Imweb immediately redirects to a new page

For more details, see the Imweb FAQ.
{% endhint %}

### Default Events

Events that the Hackle SDK collects by default. Use them to understand page-level or Session-level actions.

#### $page\_view

Collected when any page is entered.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key | Description | Type/Format | Example |
| ------------ | ----------- | ----------- | ------- |
| `$page_name` | Page name   | String      | -       |

</details>

#### $engagement

Collected when the browser's active state changes.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key          | Description                     | Type/Format | Example |
| --------------------- | ------------------------------- | ----------- | ------- |
| `$page_name`          | Page name                       | String      | -       |
| `$engagement_time_ms` | Page active time (milliseconds) | Number      | -       |

</details>

#### $session\_start

Collected when a Session starts.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

#### $session\_end

Collected when a Session ends.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

{% hint style="info" %}
For the default properties that the Hackle SDK collects automatically, see Hackle Properties.
{% endhint %}

### Screen Events

Events collected when a user enters a main page of the store or scrolls a page.

{% hint style="info" %}
`page_name` is a value that identifies the current page. It is one of `home` / `product` / `cart` / `checkout` / `completed_order` / `mypage` / `login` / `search`, and the Event is not collected if the page cannot be determined.

`pre_page_name` is the `page_name` of the previously viewed page, and is not collected on a first visit.
{% endhint %}

#### view\_home

Collected when the store home is entered.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key    | Description                 | Type/Format | Example   |
| --------------- | --------------------------- | ----------- | --------- |
| `page_name`     | Current page name           | String      | `home`    |
| `pre_page_name` | Previously viewed page name | String      | `product` |

</details>

#### view\_product

Collected when a product detail page is entered.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key    | Description                 | Type/Format | Example   |
| --------------- | --------------------------- | ----------- | --------- |
| `page_name`     | Current page name           | String      | `product` |
| `pre_page_name` | Previously viewed page name | String      | `home`    |
| `product_id`    | Product number              | Number      | `12`      |

</details>

#### view\_cart

Collected when the cart page is entered.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key    | Description                                                                                                            | Type/Format | Example    |
| --------------- | ---------------------------------------------------------------------------------------------------------------------- | ----------- | ---------- |
| `page_name`     | Current page name                                                                                                      | String      | `cart`     |
| `pre_page_name` | Previously viewed page name                                                                                            | String      | `product`  |
| `product_ids`   | <p>List of product numbers in the cart<br>Not collected if the cart information cannot be loaded within 3 seconds.</p> | Number\[]   | `[12, 34]` |

</details>

#### view\_checkout

Collected when the checkout page is entered.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key    | Description                 | Type/Format | Example             |
| --------------- | --------------------------- | ----------- | ------------------- |
| `page_name`     | Current page name           | String      | `checkout`          |
| `pre_page_name` | Previously viewed page name | String      | `cart`              |
| `order_id`      | Order number                | String      | `"202609299969458"` |

</details>

#### view\_completed\_order

Collected when the payment completion page is entered.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key           | Description                                                   | Type/Format           | Example                      |
| ---------------------- | ------------------------------------------------------------- | --------------------- | ---------------------------- |
| `page_name`            | Current page name                                             | String                | `completed_order`            |
| `pre_page_name`        | Previously viewed page name                                   | String                | `checkout`                   |
| `order_id`             | Order number                                                  | String                | `"202609299969458"`          |
| `price`                | Product amount                                                | Number                | `15000`                      |
| `discounted_amount`    | Actual payment amount                                         | Number                | `13000`                      |
| `delivery_fee_amount`  | Shipping fee (sum of basic, additional, and remote-area fees) | Number                | `3500`                       |
| `is_coupon_used_order` | Whether a coupon was used in the order                        | Boolean               | `false`                      |
| `total_quantity`       | Total quantity of ordered products                            | Number                | `3`                          |
| `items_count`          | Number of order item lines                                    | Number                | `2`                          |
| `product_ids`          | List of ordered product numbers                               | Number\[]             | `[1, 2]`                     |
| `product_names`        | List of ordered product names                                 | String\[]             | `["The Kick", "The matcha"]` |
| `currency`             | Currency                                                      | String                | `KRW`                        |
| `payment_method`       | Payment method code (as provided by Imweb)                    | String                | `OPM01`                      |
| `is_first_order`       | Whether it is the first order                                 | Boolean               | `false`                      |
| `order_datetime`       | Order time                                                    | `yyyy-MM-dd HH:mm:ss` | `2026-09-29 18:26:39`        |
| `order_date`           | Order date                                                    | `yyyyMMdd`            | `20260929`                   |

</details>

#### view\_mypage

Collected when My Page is entered.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key    | Description                 | Type/Format | Example  |
| --------------- | --------------------------- | ----------- | -------- |
| `page_name`     | Current page name           | String      | `mypage` |
| `pre_page_name` | Previously viewed page name | String      | `home`   |

</details>

#### view\_login

Collected when the login page is entered.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key    | Description                 | Type/Format | Example |
| --------------- | --------------------------- | ----------- | ------- |
| `page_name`     | Current page name           | String      | `login` |
| `pre_page_name` | Previously viewed page name | String      | `home`  |

</details>

#### view\_search

Collected when the search results page is entered.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key    | Description                 | Type/Format | Example  |
| --------------- | --------------------------- | ----------- | -------- |
| `page_name`     | Current page name           | String      | `search` |
| `pre_page_name` | Previously viewed page name | String      | `home`   |

</details>

#### scroll\_home

Collected each time the scroll depth on the home page reaches a 5% increment. Each step is collected only once.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key | Description                 | Type/Format | Example |
| ------------ | --------------------------- | ----------- | ------- |
| `depth`      | Scroll depth (%) · 5 \~ 100 | String      | `"20"`  |

</details>

#### scroll\_product

Collected each time the scroll depth on the product detail page reaches a 5% increment. Each step is collected only once.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key | Description                 | Type/Format | Example |
| ------------ | --------------------------- | ----------- | ------- |
| `product_id` | Product number              | Number      | `12`    |
| `depth`      | Scroll depth (%) · 5 \~ 100 | String      | `"20"`  |

</details>

### Member Events

#### signup

Collected when sign-up is completed. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key | Description     | Type/Format | Example                  |
| ------------ | --------------- | ----------- | ------------------------ |
| `unit_code`  | Imweb unit code | String      | `u2025012465b0fbe8ce0dy` |
| `member_id`  | Member ID       | String      | `test_member@imweb.me`   |

</details>

{% hint style="info" %}
When sign-up is completed, member information is also retrieved to set the `join_*`, `name`, `email`, `gender`, `birth_*`, phone number, `sms`, `third_party_agree`, `grade_code`, and `available_point` User Properties.

This Event is not collected for members created through bulk member registration.
{% endhint %}

#### signup\_web

Collected when the sign-up form is submitted. It is collected at the time of submission regardless of whether the sign-up succeeds.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key    | Description                           | Type/Format           | Example               |
| --------------- | ------------------------------------- | --------------------- | --------------------- |
| `join_method`   | Sign-up method (`general` / `social`) | String                | `general`             |
| `join_date`     | Sign-up date                          | `yyyyMMdd`            | `20260930`            |
| `join_datetime` | Sign-up time                          | `yyyy-MM-dd HH:mm:ss` | `2026-09-30 18:26:39` |

</details>

#### login\_web

Collected on the first page right after logging in.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key     | Description | Type/Format           | Example                |
| ---------------- | ----------- | --------------------- | ---------------------- |
| `login_date`     | Login date  | `yyyyMMdd`            | `20260930`             |
| `login_datetime` | Login time  | `yyyy-MM-dd HH:mm:ss` | `2026-09-30 18:26:39`  |
| `member_id`      | Member ID   | String                | `test_member@imweb.me` |

</details>

### Cart Events

#### click\_add\_to\_cart

Collected when Add to Cart is clicked on the product detail page.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key | Description                         | Type/Format | Example                    |
| ------------ | ----------------------------------- | ----------- | -------------------------- |
| `product_id` | Product number                      | Number      | `12`                       |
| `cart_type`  | Cart type (`normal` / `regularly`)  | String      | `normal`                   |
| `source`     | Imweb function path that was called | String      | `SITE_SHOP_DETAIL.addCart` |

</details>

#### add\_to\_cart

Collected when a product is added to the cart. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key | Description     | Type/Format | Example                  |
| ------------ | --------------- | ----------- | ------------------------ |
| `unit_code`  | Imweb unit code | String      | `u2025012465b0fbe8ce0dy` |
| `product_id` | Product number  | Number      | `1001`                   |
| `quantity`   | Quantity added  | Number      | `2`                      |

</details>

#### add\_to\_cart\_items

Collected per product for products added to the cart. Since one product is added at a time, it is collected 1:1 with `add_to_cart`. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key        | Description       | Type/Format | Example                  |
| ------------------- | ----------------- | ----------- | ------------------------ |
| `unit_code`         | Imweb unit code   | String      | `u2025012465b0fbe8ce0dy` |
| `product_id`        | Product number    | Number      | `1001`                   |
| `option_id`         | Option code       | String      | `O2024092566f3726054a3a` |
| `option_name`       | Option name       | String      | `색상`                     |
| `option_value_id`   | Option value code | String      | `O202409254e3180103a548` |
| `option_value_name` | Option value name | String      | `100`                    |
| `quantity`          | Quantity added    | Number      | `2`                      |

</details>

### Order Events

#### click\_buy\_product

Collected when Buy Now is clicked on the product detail page.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key    | Description                         | Type/Format | Example   |
| --------------- | ----------------------------------- | ----------- | --------- |
| `page_name`     | Current page name                   | String      | `product` |
| `product_id`    | Product number                      | Number      | `12`      |
| `checkout_type` | Order method (as provided by Imweb) | String      | `normal`  |

</details>

#### click\_buy\_cart

Collected when Buy is clicked in the cart.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key    | Description                                                | Type/Format | Example                  |
| --------------- | ---------------------------------------------------------- | ----------- | ------------------------ |
| `page_name`     | Current page name                                          | String      | `cart`                   |
| `purchase_unit` | Purchase unit (`single` Buy Now / `selected` Buy Selected) | String      | `selected`               |
| `items_count`   | Number of product types being purchased                    | Number      | `1`                      |
| `cart_code`     | Cart code                                                  | String      | `c20260921f8c9c5a4f9c65` |
| `checkout_type` | Order method (as provided by Imweb)                        | String      | `normal`                 |

</details>

#### complete\_order

Collected when an order is created. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key                | Description                                                        | Type/Format           | Example                  |
| --------------------------- | ------------------------------------------------------------------ | --------------------- | ------------------------ |
| `unit_code`                 | Imweb unit code                                                    | String                | `u2025012465b0fbe8ce0dy` |
| `order_id`                  | Order number                                                       | String                | `"202503073069582"`      |
| `external_order_id`         | Sales channel order number                                         | String                | `202503073069582`        |
| `sale_channel`              | Sales channel                                                      | String                | `IMWEB`                  |
| `member_id`                 | Member ID                                                          | String                | `test_member@imweb.me`   |
| `is_member`                 | Whether it is a member order (always `true`)                       | Boolean               | `true`                   |
| `order_device`              | Order device                                                       | String                | `PC`                     |
| `is_first_order`            | Whether it is the first order                                      | Boolean               | `true`                   |
| `is_gift`                   | Whether it is a gift order                                         | Boolean               | `false`                  |
| `buyer_name`                | Buyer name                                                         | String                | `홍길동`                    |
| `buyer_email`               | Buyer email                                                        | String                | `test_member@imweb.me`   |
| `currency`                  | Currency                                                           | String                | `KRW`                    |
| `total_order_amount`        | Order amount                                                       | String                | `"1000000"`              |
| `total_payment_amount`      | Actual payment amount                                              | String                | `"1000000"`              |
| `total_discount_amount`     | Total discount amount                                              | String                | `"0"`                    |
| `total_point_used_amount`   | Reward points used                                                 | String                | `"0"`                    |
| `total_delivery_fee_amount` | Shipping fee                                                       | String                | `"3000"`                 |
| `payment_method`            | Payment method (as provided by Imweb)                              | String                | `BANKTRANSFER`           |
| `payment_status`            | Payment status (as provided by Imweb)                              | String                | `PAYMENT_COMPLETE`       |
| `deposit_expire_datetime`   | Deposit deadline time (collected only for bank transfer payments)  | `yyyy-MM-dd HH:mm:ss` | `2025-08-07 10:44:32`    |
| `deposit_expire_date`       | Deposit deadline date                                              | `yyyy-MM-dd`          | `2025-08-07`             |
| `product_ids`               | List of ordered product numbers                                    | Number\[]             | `[1001, 1002]`           |
| `product_summary`           | First product name and the number of remaining items               | String                | `상품명 외 1건`               |
| `product_names`             | List of ordered product names                                      | String\[]             | `["상품명"]`                |
| `items_count`               | Number of order item lines                                         | Number                | `2`                      |
| `order_datetime`            | Order time                                                         | `yyyy-MM-dd HH:mm:ss` | `2025-03-07 10:00:00`    |
| `order_date`                | Order date                                                         | `yyyy-MM-dd`          | `2025-03-07`             |
| `payment_datetime`          | Payment completion time (collected only when payment is completed) | `yyyy-MM-dd HH:mm:ss` | `2025-08-06 10:44:32`    |
| `payment_date`              | Payment completion date                                            | `yyyy-MM-dd`          | `2025-08-06`             |

</details>

{% hint style="info" %}
This Event is not collected for non-member orders. Events are also not collected in duplicate for the same order.
{% endhint %}

#### complete\_order\_items

Collected for each order item line when an order is created. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

Includes all Event Properties of `complete_order`, with the following properties added.

| Property Key    | Description       | Type/Format | Example               |
| --------------- | ----------------- | ----------- | --------------------- |
| `product_id`    | Product number    | Number      | `1001`                |
| `product_name`  | Product name      | String      | `상품명`                 |
| `order_item_id` | Order item number | String      | `202503073069582-001` |
| `quantity`      | Quantity          | Number      | `1`                   |
| `option_name`   | Option name       | String      | `사이즈, 색상`             |
| `option_value`  | Option value      | String      | `S, 블랙`               |

</details>

#### ready\_shipping

Collected for each shipping section when an order enters the awaiting-shipment status. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

Includes all Event Properties of `complete_order`, and the following properties are collected again on a per-shipping-section basis.

| Property Key        | Description                                                     | Type/Format | Example                  |
| ------------------- | --------------------------------------------------------------- | ----------- | ------------------------ |
| `unit_code`         | Imweb unit code                                                 | String      | `u2025012465b0fbe8ce0dy` |
| `order_id`          | Order number                                                    | String      | `"202503073069582"`      |
| `external_order_id` | Sales channel order number                                      | String      | `202503073069582`        |
| `sale_channel`      | Sales channel                                                   | String      | `IMWEB`                  |
| `member_id`         | Member ID                                                       | String      | `test_member@imweb.me`   |
| `is_member`         | Whether it is a member order (always `true`)                    | Boolean     | `true`                   |
| `product_ids`       | List of product numbers in this shipping section                | Number\[]   | `[1001]`                 |
| `product_summary`   | First product name and remaining count in this shipping section | String      | `상품명`                    |
| `product_names`     | List of product names in this shipping section                  | String\[]   | `["상품명"]`                |
| `items_count`       | Number of product lines in this shipping section                | Number      | `1`                      |

</details>

{% hint style="info" %}
This Event is not collected for exchange shipments.
{% endhint %}

#### ready\_shipping\_items

Collected for each product line when an order enters the awaiting-shipment status. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

Includes all Event Properties of `ready_shipping`, with the following properties added.

| Property Key    | Description       | Type/Format | Example               |
| --------------- | ----------------- | ----------- | --------------------- |
| `product_id`    | Product number    | Number      | `1001`                |
| `product_name`  | Product name      | String      | `상품명`                 |
| `order_item_id` | Order item number | String      | `202503073069582-001` |
| `quantity`      | Quantity          | Number      | `1`                   |
| `option_name`   | Option name       | String      | `사이즈, 색상`             |
| `option_value`  | Option value      | String      | `S, 블랙`               |

</details>

#### start\_shipping

Collected for each shipping section when shipping starts. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

Includes all Event Properties of `complete_order`, and the following properties are collected again on a per-shipping-section basis.

| Property Key           | Description                                                     | Type/Format | Example                  |
| ---------------------- | --------------------------------------------------------------- | ----------- | ------------------------ |
| `unit_code`            | Imweb unit code                                                 | String      | `u2025012465b0fbe8ce0dy` |
| `order_id`             | Order number                                                    | String      | `"202503073069582"`      |
| `external_order_id`    | Sales channel order number                                      | String      | `202503073069582`        |
| `sale_channel`         | Sales channel                                                   | String      | `IMWEB`                  |
| `member_id`            | Member ID                                                       | String      | `test_member@imweb.me`   |
| `is_member`            | Whether it is a member order (always `true`)                    | Boolean     | `true`                   |
| `product_ids`          | List of product numbers in this shipping section                | Number\[]   | `[1001]`                 |
| `product_summary`      | First product name and remaining count in this shipping section | String      | `상품명`                    |
| `product_names`        | List of product names in this shipping section                  | String\[]   | `["상품명"]`                |
| `items_count`          | Number of product lines in this shipping section                | Number      | `1`                      |
| `tracking_number`      | Tracking number (collected only when registered)                | String      | `123456789012`           |
| `shipping_company_idx` | Imweb courier number                                            | Number      | `1`                      |

</details>

{% hint style="info" %}
This Event is not collected for exchange shipments.
{% endhint %}

#### start\_shipping\_items

Collected for each product line when shipping starts. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

Includes all Event Properties of `start_shipping`, with the following properties added.

| Property Key    | Description       | Type/Format | Example               |
| --------------- | ----------------- | ----------- | --------------------- |
| `product_id`    | Product number    | Number      | `1001`                |
| `product_name`  | Product name      | String      | `상품명`                 |
| `order_item_id` | Order item number | String      | `202503073069582-001` |
| `quantity`      | Quantity          | Number      | `1`                   |
| `option_name`   | Option name       | String      | `사이즈, 색상`             |
| `option_value`  | Option value      | String      | `S, 블랙`               |

</details>

#### complete\_shipping

Collected for each shipping section when shipping is completed. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

Includes all Event Properties of `complete_order`, and the following properties are collected again on a per-shipping-section basis.

| Property Key           | Description                                                     | Type/Format | Example                  |
| ---------------------- | --------------------------------------------------------------- | ----------- | ------------------------ |
| `unit_code`            | Imweb unit code                                                 | String      | `u2025012465b0fbe8ce0dy` |
| `order_id`             | Order number                                                    | String      | `"202503073069582"`      |
| `external_order_id`    | Sales channel order number                                      | String      | `202503073069582`        |
| `sale_channel`         | Sales channel                                                   | String      | `IMWEB`                  |
| `member_id`            | Member ID                                                       | String      | `test_member@imweb.me`   |
| `is_member`            | Whether it is a member order (always `true`)                    | Boolean     | `true`                   |
| `product_ids`          | List of product numbers in this shipping section                | Number\[]   | `[1001]`                 |
| `product_summary`      | First product name and remaining count in this shipping section | String      | `상품명`                    |
| `product_names`        | List of product names in this shipping section                  | String\[]   | `["상품명"]`                |
| `items_count`          | Number of product lines in this shipping section                | Number      | `1`                      |
| `tracking_number`      | Tracking number (collected only when registered)                | String      | `123456789012`           |
| `shipping_company_idx` | Imweb courier number                                            | Number      | `1`                      |

</details>

{% hint style="info" %}
This Event is not collected for exchange shipments.
{% endhint %}

#### complete\_shipping\_items

Collected for each product line when shipping is completed. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

Includes all Event Properties of `complete_shipping`, with the following properties added.

| Property Key    | Description       | Type/Format | Example               |
| --------------- | ----------------- | ----------- | --------------------- |
| `product_id`    | Product number    | Number      | `1001`                |
| `product_name`  | Product name      | String      | `상품명`                 |
| `order_item_id` | Order item number | String      | `202503073069582-001` |
| `quantity`      | Quantity          | Number      | `1`                   |
| `option_name`   | Option name       | String      | `사이즈, 색상`             |
| `option_value`  | Option value      | String      | `S, 블랙`               |

</details>

#### click\_cancel\_order

Collected when an order cancellation is requested.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key    | Description         | Type/Format | Example             |
| --------------- | ------------------- | ----------- | ------------------- |
| `order_id`      | Order number        | String      | `"202609299969458"` |
| `cancel_reason` | Cancellation reason | String      | `INTENT_CHANGED`    |
| `order_type`    | Order type          | String      | -                   |

</details>

#### cancel\_order

Collected for each cancellation section when an order cancellation is completed. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

Includes all Event Properties of `complete_order`, with the following properties added. The cancellation amount is not provided by Imweb and is therefore not collected.

| Property Key             | Description                                      | Type/Format           | Example                  |
| ------------------------ | ------------------------------------------------ | --------------------- | ------------------------ |
| `unit_code`              | Imweb unit code                                  | String                | `u2025012465b0fbe8ce0dy` |
| `order_id`               | Order number                                     | String                | `"202503073069582"`      |
| `external_order_id`      | Sales channel order number                       | String                | `202503073069582`        |
| `sale_channel`           | Sales channel                                    | String                | `IMWEB`                  |
| `member_id`              | Member ID                                        | String                | `test_member@imweb.me`   |
| `is_member`              | Whether it is a member order (always `true`)     | Boolean               | `true`                   |
| `cancel_product_ids`     | List of cancelled product numbers                | Number\[]             | `[1001]`                 |
| `cancel_product_summary` | First cancelled product name and remaining count | String                | `상품명`                    |
| `cancel_product_names`   | List of cancelled product names                  | String\[]             | `["상품명"]`                |
| `cancel_items_count`     | Number of cancelled product lines                | Number                | `1`                      |
| `cancel_datetime`        | Cancellation completion time                     | `yyyy-MM-dd HH:mm:ss` | `2026-09-01 10:00:00`    |
| `cancel_date`            | Cancellation completion date                     | `yyyy-MM-dd`          | `2026-09-01`             |
| `cancel_reason`          | Cancellation reason                              | String                | `취소 사유`                  |
| `cancel_reason_detail`   | Cancellation reason detail                       | String                | `취소 사유 상세`               |

</details>

#### cancel\_order\_items

Collected for each product line when an order cancellation is completed. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

Includes all Event Properties of `cancel_order`, with the following properties added.

| Property Key      | Description        | Type/Format | Example               |
| ----------------- | ------------------ | ----------- | --------------------- |
| `product_id`      | Product number     | Number      | `1001`                |
| `product_name`    | Product name       | String      | `상품명`                 |
| `order_item_id`   | Order item number  | String      | `202503073069582-001` |
| `quantity`        | Quantity           | Number      | `1`                   |
| `option_name`     | Option name        | String      | `사이즈, 색상`             |
| `option_value`    | Option value       | String      | `S, 블랙`               |
| `cancel_quantity` | Cancelled quantity | Number      | `1`                   |

</details>

#### click\_return\_order

Collected when a return is requested.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key    | Description   | Type/Format | Example             |
| --------------- | ------------- | ----------- | ------------------- |
| `order_id`      | Order number  | String      | `"202609299969458"` |
| `return_reason` | Return reason | String      | `PRODUCT_UNSATIS`   |

</details>

#### return\_order

Collected for each return section when an order return is completed. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

Includes all Event Properties of `complete_order`, with the following properties added. The return amount is not provided by Imweb and is therefore not collected.

| Property Key             | Description                                     | Type/Format           | Example                  |
| ------------------------ | ----------------------------------------------- | --------------------- | ------------------------ |
| `unit_code`              | Imweb unit code                                 | String                | `u2025012465b0fbe8ce0dy` |
| `order_id`               | Order number                                    | String                | `"202503073069582"`      |
| `external_order_id`      | Sales channel order number                      | String                | `202503073069582`        |
| `sale_channel`           | Sales channel                                   | String                | `IMWEB`                  |
| `member_id`              | Member ID                                       | String                | `test_member@imweb.me`   |
| `is_member`              | Whether it is a member order (always `true`)    | Boolean               | `true`                   |
| `return_product_ids`     | List of returned product numbers                | Number\[]             | `[1001]`                 |
| `return_product_summary` | First returned product name and remaining count | String                | `상품명`                    |
| `return_product_names`   | List of returned product names                  | String\[]             | `["상품명"]`                |
| `return_items_count`     | Number of returned product lines                | Number                | `1`                      |
| `return_datetime`        | Return completion time                          | `yyyy-MM-dd HH:mm:ss` | `2026-09-01 10:00:00`    |
| `return_date`            | Return completion date                          | `yyyy-MM-dd`          | `2026-09-01`             |
| `return_reason`          | Return reason                                   | String                | `반품 사유`                  |
| `return_reason_detail`   | Return reason detail                            | String                | `반품 사유 상세`               |

</details>

#### return\_order\_items

Collected for each product line when an order return is completed. This Event occurs on the Imweb server.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

Includes all Event Properties of `return_order`, with the following properties added.

| Property Key      | Description       | Type/Format | Example               |
| ----------------- | ----------------- | ----------- | --------------------- |
| `product_id`      | Product number    | Number      | `1001`                |
| `product_name`    | Product name      | String      | `상품명`                 |
| `order_item_id`   | Order item number | String      | `202503073069582-001` |
| `quantity`        | Quantity          | Number      | `1`                   |
| `return_quantity` | Returned quantity | Number      | `1`                   |

</details>

#### click\_exchange\_order

Collected when an exchange is requested.

**Collection Timing** Real-time · **In-App Message** Not supported · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key      | Description     | Type/Format | Example             |
| ----------------- | --------------- | ----------- | ------------------- |
| `order_id`        | Order number    | String      | `"202609299969458"` |
| `exchange_reason` | Exchange reason | String      | `PRODUCT_UNSATIS`   |

</details>

{% hint style="warning" %}
For exchanges, only `click_exchange_order` at the time of the request is collected. Exchange approval and exchange shipping are not provided by Imweb and are therefore not collected.
{% endhint %}

### Other Events

#### click\_wishlist

Collected when an item is added to or removed from the wishlist. It is not collected on the cart page.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key      | Description                                                | Type/Format | Example                  |
| ----------------- | ---------------------------------------------------------- | ----------- | ------------------------ |
| `page_name`       | Current page name                                          | String      | `product`                |
| `product_code`    | Product code                                               | String      | `S201801295a6e17e03a333` |
| `product_id`      | Product number (collected only on the product detail page) | Number      | `12`                     |
| `wishlist_action` | Wishlist action (`add` / `delete`)                         | String      | `add`                    |

</details>

#### click\_download\_coupon

Collected when a coupon is downloaded.

**Collection Timing** Real-time · **In-App Message** Available · **Non-member Sending** Not supported

<details>

<summary>View Event Properties</summary>

| Property Key   | Description                                                                                                                                                                                                            | Type/Format | Example                      |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ---------------------------- |
| `page_name`    | Current page name                                                                                                                                                                                                      | String      | `product`                    |
| `source`       | <p>Where the download occurred<br><code>detailPageDownCoupon</code> Product detail<br><code>downloadEntireCoupon</code> Download all<br><code>mypage\_down\_use\_coupon</code> Individual download from coupon box</p> | String      | `detailPageDownCoupon`       |
| `coupon_codes` | List of downloaded coupon codes                                                                                                                                                                                        | String\[]   | `["c20250124f19b3a713d31a"]` |

</details>

### Custom Events

In addition to the Events that the plugin collects automatically, you can create Custom Events.

#### GTM Integration

When creating Custom Events in Imweb, we recommend using GTM (Google Tag Manager).

If you already have an existing `trigger` or `tag`, you can use it to send Events to Hackle.

For more details, see GTM Integration.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.hackle.io/en/imweb/events.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
