> 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/event-management/hackle-event.md).

# Hackle Event (Auto-collected)

Events whose Event Key starts with `$` are events managed separately by Hackle.

## 1. Auto-collected Events

{% hint style="info" %}
Auto-collected events are only collected by Web / App SDKs.
{% endhint %}

In the \[Auto-collected Events] section of Event Management, you can view events that are automatically collected without separately sending events.

![Event Management > Auto-collected Events](https://143363954-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyAVlNQhS253reum0Ce94%2Fuploads%2Fgit-blob-3e3920217c692b8afb2869cb6829f7f6ef49126c%2F3fc16832e7322008c1971a3ffc25f553509f71b6_1adf52b638f9fdfc.png?alt=media)

<table data-full-width="true"><thead><tr><th width="157.93359375">Event Key</th><th width="396.88671875">Description</th><th width="79.78125">Web</th><th width="76.4296875">App</th><th width="73.90625">Billing</th><th width="90.53125">on/off</th></tr></thead><tbody><tr><td><code>$page_view</code></td><td><p>Event collected when a page loads.</p><ul><li>Web: page title</li><li>App: Activity, ViewController</li></ul></td><td>O</td><td>O</td><td>O</td><td>Available</td></tr><tr><td><code>$engagement</code></td><td><p>Collects the page a user stayed on and the time spent as properties.<br>Can be used for the following data analysis:</p><ul><li>Average dwell time per page</li><li>Average dwell time per user</li></ul></td><td>O</td><td>O</td><td>O</td><td>Available</td></tr><tr><td><code>$session_start</code></td><td>Automatically collected when a session starts.</td><td>O</td><td>O</td><td>O</td><td>Available</td></tr><tr><td><code>$session_end</code></td><td>Collected when a session ends.</td><td>O</td><td>O</td><td>O</td><td>Available</td></tr><tr><td><code>$app_install</code></td><td>Collected on the first launch after app installation.</td><td>X</td><td>O</td><td>O</td><td>Available</td></tr><tr><td><code>$app_update</code></td><td>Collected on the first launch after an app update.</td><td>X</td><td>O</td><td>O</td><td>Available</td></tr><tr><td><code>$app_open</code></td><td>Collected when the app is launched or reactivated.</td><td>X</td><td>O</td><td>O</td><td>Available</td></tr><tr><td><code>$app_background</code></td><td>Collected when the app transitions from an active state (foreground) to an inactive state (background).</td><td>X</td><td>O</td><td>O</td><td>Available</td></tr></tbody></table>

## 2. User Property Collection Events

Events collected when a function is called via SDK/API to update user properties.

<table data-full-width="true"><thead><tr><th width="194.95703125">Event Key</th><th width="350.60546875">Description</th><th width="78.82421875">Web</th><th width="77.53515625">App</th><th width="73.84765625">Billing</th><th width="92.7265625">on/off</th></tr></thead><tbody><tr><td><code>$properties</code></td><td>An event automatically created by the SDK when general user properties are updated.</td><td>O</td><td>O</td><td>X</td><td>Not available</td></tr><tr><td><code>$push_subscriptions</code></td><td>An event automatically created by the SDK when the push channel subscription consent among CRM user properties is updated.</td><td>O</td><td>O</td><td>O</td><td>Not available</td></tr><tr><td><code>$kakao_subscriptions</code></td><td>An event automatically created by the SDK when the Kakao Message channel subscription consent among CRM user properties is updated.</td><td>O</td><td>O</td><td>O</td><td>Not available</td></tr><tr><td><code>$sms_subscriptions</code></td><td>An event automatically created by the SDK when the Text Message channel subscription consent among CRM user properties is updated.</td><td>O</td><td>O</td><td>O</td><td>Not available</td></tr></tbody></table>

## 3. CRM Campaign Events

Events occurring from In-App Messages, Push Messages, Kakao Messages, Text Messages, Webhooks, and User Journeys in CRM campaigns are auto-collected and always collected for performance measurement. Collection cannot be turned off, and all of them are billable.

<table data-full-width="true"><thead><tr><th width="200">Event Key</th><th width="140">Channel</th><th>Description</th></tr></thead><tbody><tr><td><code>$in_app_impression</code></td><td>In-App Message</td><td>Event that occurs when an In-App Message is displayed.</td></tr><tr><td><code>$in_app_action</code></td><td>In-App Message</td><td>Event that occurs when an In-App Message is clicked.</td></tr><tr><td><code>$push_send</code></td><td>Push Message</td><td>Event that occurs when a Push Message is sent.</td></tr><tr><td><code>$push_click</code></td><td>Push Message</td><td>Event that occurs when a Push Message is clicked.</td></tr><tr><td><code>$kakao_send</code></td><td>Kakao Message</td><td>Event that occurs when a Kakao Message is sent.</td></tr><tr><td><code>$kakao_click</code></td><td>Kakao Message</td><td>Event that occurs when a link in a Kakao Message is clicked.<br>Collected only in campaigns that use tracking links.</td></tr><tr><td><code>$sms_send</code></td><td>Text Message</td><td>Event that occurs when a Text Message is sent.</td></tr><tr><td><code>$webhook_send</code></td><td>Webhook</td><td>Event that occurs when a Webhook is sent.</td></tr><tr><td><code>$journey_entry</code></td><td>User Journey</td><td>Event that occurs when a user enters a journey.</td></tr><tr><td><code>$journey_node</code></td><td>User Journey</td><td>Event that occurs when a user enters a specific node (step) of a journey.</td></tr><tr><td><code>$journey_complete</code></td><td>User Journey</td><td>Event that occurs when a user completes a journey.</td></tr></tbody></table>

### Event Properties

These are the properties collected with each event. Properties collected only under specific conditions are marked in \[Collection Condition].

### Common Properties

Collected in common for `$push_send`, `$kakao_send`, `$sms_send`, and `$webhook_send`.

| Property                     | Description                                                                           | Collection Condition |
| ---------------------------- | ------------------------------------------------------------------------------------- | -------------------- |
| `campaign_id`                | Campaign ID                                                                           |                      |
| `campaign_key`               | Campaign key                                                                          |                      |
| `campaign_type`              | Campaign type (`PUSH_MESSAGE`, `KAKAO_MESSAGE`, `TEXT_MESSAGE`, `WEBHOOK`, `JOURNEY`) |                      |
| `dispatch_id`                | Identifier of the send request                                                        |                      |
| `delivery_version`           | Delivery version                                                                      |                      |
| `channel_mode`               | Channel delivery mode                                                                 |                      |
| `tag_ids`                    | List of tag IDs set on the campaign                                                   |                      |
| `tag_keys`                   | List of tag keys set on the campaign                                                  |                      |
| `campaign_strategy`          | Campaign delivery strategy                                                            |                      |
| `campaign_strategy_channels` | List of channels included in the delivery strategy                                    |                      |
| `debug`                      | Whether it is a test send                                                             |                      |
| `task_id`                    | Scheduled send task ID                                                                | Scheduled send       |
| `task_execution_id`          | Scheduled send task execution ID                                                      | Scheduled send       |
| `task_deliver_time`          | Scheduled send time (UTC)                                                             | Scheduled send       |
| `experiment_id`              | A/B Test ID                                                                           | Message A/B Test     |
| `experiment_key`             | A/B Test key                                                                          | Message A/B Test     |
| `experiment_version`         | A/B Test version                                                                      | Message A/B Test     |
| `variation_id`               | Assigned test group ID                                                                | Message A/B Test     |
| `variation_key`              | Assigned test group key                                                               | Message A/B Test     |
| `experiment_decision_reason` | Reason for test group assignment                                                      | Message A/B Test     |

***

### In-App Message Properties

The following properties are collected in common for all In-App Message events.

| Property                      | Description                     |
| ----------------------------- | ------------------------------- |
| `in_app_message_id`           | In-App Message campaign ID      |
| `in_app_message_key`          | In-App Message campaign key     |
| `in_app_message_display_type` | Message display type            |
| `decision_reason`             | Reason for the display decision |

**`$in_app_impression`** : Message impression

| Property      | Description                                  |
| ------------- | -------------------------------------------- |
| `title_text`  | Title text                                   |
| `body_text`   | Body text                                    |
| `button_text` | List of button texts included in the message |
| `image_url`   | List of image paths included in the message  |

**`$in_app_action`** : Message click

| Property       | Description                                   | Collection Condition                          |
| -------------- | --------------------------------------------- | --------------------------------------------- |
| `action_type`  | Type of click action                          |                                               |
| `action_value` | Click action value (e.g., URL to navigate to) |                                               |
| `action_area`  | Area where the click occurred                 |                                               |
| `button_text`  | Text of the clicked button                    | Button click                                  |
| `image_url`    | Path of the clicked image                     | Image click                                   |
| `image_order`  | Position of the clicked image                 | Image click                                   |
| `element_id`   | ID of the clicked element                     | `trackClick` called in an HTML In-App Message |

***

### Push Message Properties

**`$push_send`** : Send

In addition to the common campaign properties, the following properties are collected.

| Property                            | Description                                  | Collection Condition     |
| ----------------------------------- | -------------------------------------------- | ------------------------ |
| `push_message_title`                | Push title                                   |                          |
| `push_message_body`                 | Push body                                    |                          |
| `push_message_action_type`          | Type of action on click                      |                          |
| `push_message_action_value`         | Action value on click                        |                          |
| `push_message_image_url`            | Push image URL                               | When an image is set     |
| `push_message_large_icon_image_url` | Large icon image URL                         | When a large icon is set |
| `platform_type`                     | Recipient device platform (`IOS`, `ANDROID`) |                          |
| `provider_type`                     | Push delivery channel (`FCM`, `APN`)         |                          |
| `push_token`                        | Push token of the recipient                  |                          |
| `result`                            | Send result                                  |                          |
| `error`                             | Reason for send failure                      | Send failure             |
| `push_message_id`                   | Push Message campaign ID                     | Push Message campaign    |
| `push_message_key`                  | Push Message campaign key                    | Push Message campaign    |
| `push_message_execution_id`         | Push Message execution ID                    | Push Message campaign    |

**`$push_click`** : Click

Clicks are collected by the SDK, so the property set differs from the send event.

| Property                    | Description                                  | Collection Condition        |
| --------------------------- | -------------------------------------------- | --------------------------- |
| `campaign_type`             | Campaign type (`PUSH_MESSAGE`, `JOURNEY`)    |                             |
| `push_message_id`           | Push Message campaign ID                     |                             |
| `push_message_key`          | Push Message campaign key                    |                             |
| `push_message_execution_id` | Push Message execution ID                    |                             |
| `push_message_delivery_id`  | Identifier of the push delivery              |                             |
| `journey_id`                | Journey ID                                   | `campaign_type` = `JOURNEY` |
| `journey_key`               | Journey key                                  | `campaign_type` = `JOURNEY` |
| `journey_node_id`           | ID of the journey node that sent the message | `campaign_type` = `JOURNEY` |
| `debug`                     | Whether it is a test send                    |                             |

***

### Kakao Message Properties

**`$kakao_send`** : Send

In addition to the common campaign properties, the following properties are collected.

| Property              | Description                                                                                                                         | Collection Condition            |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
| `message_type`        | Message type (`ALIM_TALK`, `BASIC_BRAND_MESSAGE`, `FREESTYLE_BRAND_MESSAGE`)                                                        |                                 |
| `layout_type`         | Message layout (`TEXT`, `IMAGE`, `WIDE_IMAGE`, `WIDE_ITEM_LIST`, `CAROUSEL_FEED`, `CAROUSEL_COMMERCE`, `COMMERCE`, `PREMIUM_VIDEO`) | Brand Message                   |
| `channel_id`          | KakaoTalk Channel ID used for sending                                                                                               |                                 |
| `channel_friend_type` | Whether the recipient is a Channel friend                                                                                           |                                 |
| `template_code`       | Template code used                                                                                                                  | Alimtalk, Brand Message (Basic) |
| `template_parameters` | Variable values filled into the template                                                                                            | Alimtalk, Brand Message (Basic) |
| `targeting_type`      | Recipient targeting method                                                                                                          | Brand Message (Basic)           |
| `is_ad`               | Whether it is an advertising message                                                                                                | Brand Message                   |
| `is_adult`            | Whether it is a message for adults                                                                                                  | Brand Message                   |
| `result`              | Send result                                                                                                                         |                                 |
| `result_code`         | Send result code                                                                                                                    |                                 |
| `result_reason`       | Send result reason                                                                                                                  |                                 |
| `usage_key`           | Cash usage identifier                                                                                                               |                                 |
| `kakao_message_id`    | Kakao Message campaign ID                                                                                                           | Kakao Message campaign          |
| `kakao_message_key`   | Kakao Message campaign key                                                                                                          | Kakao Message campaign          |

**`$kakao_click`** : Click

Collected only in campaigns that use tracking links, and recorded linked to the User Identifiers (`$userid`, `$hackleid`) of the user who received the message. For how to apply tracking links, see Writing a Kakao Alimtalk and Writing a Kakao Brand Message.

Clicks are collected separately from sends, so only the properties below are collected rather than all common campaign properties.

| Property            | Description                                                                                                                                          | Collection Condition                      |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| `url`               | Destination URL of the clicked link. If UTM parameters are applied, the value is collected with the parameters included.                             |                                           |
| `message_type`      | Message type (`ALIM_TALK`, `BASIC_BRAND_MESSAGE`, `FREESTYLE_BRAND_MESSAGE`)                                                                         |                                           |
| `campaign_type`     | Type of campaign where the click occurred (`KAKAO_MESSAGE`, `JOURNEY`)                                                                               |                                           |
| `campaign_id`       | Campaign ID                                                                                                                                          |                                           |
| `campaign_key`      | Campaign key                                                                                                                                         |                                           |
| `debug`             | Whether it is a test send                                                                                                                            |                                           |
| `kakao_message_id`  | Kakao Message campaign ID                                                                                                                            | `campaign_type` = `KAKAO_MESSAGE`         |
| `kakao_message_key` | Kakao Message campaign key                                                                                                                           | `campaign_type` = `KAKAO_MESSAGE`         |
| `journey_id`        | Journey ID                                                                                                                                           | `campaign_type` = `JOURNEY`               |
| `journey_key`       | Journey key                                                                                                                                          | `campaign_type` = `JOURNEY`               |
| `journey_node_id`   | ID of the journey node that sent the message                                                                                                         | `campaign_type` = `JOURNEY`               |
| `journey_node_key`  | Key of the journey node that sent the message                                                                                                        | `campaign_type` = `JOURNEY`               |
| `layout_type`       | Message layout (`TEXT`, `IMAGE`, `WIDE_IMAGE`, `WIDE_ITEM_LIST`, `CAROUSEL_FEED`, `CAROUSEL_COMMERCE`, `COMMERCE`, `PREMIUM_VIDEO`)                  | Brand Message                             |
| `element_type`      | Type of the clicked element (`BUTTON` button, `LIST_ITEM` item list entry, `IMAGE` image, `COUPON` coupon, `CAROUSEL_TAIL` carousel "see more" card) | Brand Message                             |
| `element_order`     | Position of the clicked element                                                                                                                      | `element_type` is `BUTTON` or `LIST_ITEM` |
| `card_order`        | Position of the carousel card where the click occurred                                                                                               | Carousel layout                           |

{% hint style="warning" %}
Alimtalk can be measured only when the entire link registered in the template is a single variable, so `layout_type`, `element_type`, `element_order`, and `card_order`, which distinguish where in the message the user clicked, are not collected. To compare click performance by element, use Brand Messages (Freestyle or Basic).
{% endhint %}

{% hint style="info" %}
If the same user clicks the same link multiple times, an event is collected for each click. Duplicates are not removed, so to see how many people actually clicked the message, analyze by number of users (UV) rather than by event count.
{% endhint %}

***

### Text Message Properties

**`$sms_send`** : Send

In addition to the common campaign properties, the following properties are collected.

| Property        | Description                          | Collection Condition  |
| --------------- | ------------------------------------ | --------------------- |
| `message_type`  | Message type (`SMS`, `LMS`, `MMS`)   |                       |
| `sender_id`     | Sender number identifier             |                       |
| `is_ad`         | Whether it is an advertising message |                       |
| `result`        | Send result                          |                       |
| `result_code`   | Send result code                     |                       |
| `result_reason` | Send result reason                   |                       |
| `usage_key`     | Cash usage identifier                |                       |
| `sms_id`        | Text Message campaign ID             | Text Message campaign |
| `sms_key`       | Text Message campaign key            | Text Message campaign |

***

### Webhook Properties

**`$webhook_send`** : Send

In addition to the common campaign properties, the following properties are collected.

| Property               | Description                      | Collection Condition        |
| ---------------------- | -------------------------------- | --------------------------- |
| `http_method`          | HTTP method of the request       |                             |
| `webhook_endpoint`     | Target URL of the request        |                             |
| `webhook_headers`      | Headers used in the request      |                             |
| `http_status_code`     | HTTP status code of the response | When a response is received |
| `result`               | Send result                      |                             |
| `webhook_id`           | Webhook campaign ID              | Webhook campaign            |
| `webhook_key`          | Webhook campaign key             | Webhook campaign            |
| `webhook_execution_id` | Webhook execution ID             | Webhook campaign            |

***

### User Journey Properties

The following properties are collected in common for all journey events.

| Property               | Description                           |
| ---------------------- | ------------------------------------- |
| `journey_id`           | Journey ID                            |
| `journey_key`          | Journey key                           |
| `journey_execution_id` | Journey execution ID                  |
| `journey_instance_id`  | Per-user journey progress instance ID |

**`$journey_entry`** : Journey entry

Only the common properties are collected.

**`$journey_node`** : Node entry

| Property                      | Description                     |
| ----------------------------- | ------------------------------- |
| `journey_node_id`             | ID of the node entered          |
| `journey_node_key`            | Key of the node entered         |
| `journey_node_type`           | Node type                       |
| `journey_node_execute_status` | Node execution result           |
| `next_node`                   | Key of the next node to move to |

**`$journey_complete`** : Journey completion

| Property             | Description                         |
| -------------------- | ----------------------------------- |
| `complete_node_id`   | Node ID at the time of completion   |
| `complete_node_key`  | Node key at the time of completion  |
| `complete_node_type` | Node type at the time of completion |


---

# 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/event-management/hackle-event.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.
