> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api-guide/api-guides-en/store-front-api/main-and-full-menu/event.md).

# Event

Describes the APIs used on the event page, which call event information registered in the X2BEE BO.

Event types

* Drawing events: simple click, survey, comment, purchaser drawing
* Non-drawing events: purchase gift, attendance check, coupon download, roulette

{% hint style="info" %}
On November 6, 2023, the roulette and purchaser drawing event features were added, and descriptions for each event were added.
{% endhint %}

***

{% columns %}
{% column %}

<p align="center"><strong>PC</strong></p>

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FJ7djdY7nXFJ0ePHjZIkP%2Fimage-20240416-044219.png?alt=media&#x26;token=d4811266-b7dc-40f8-a7db-6f8ca0825787" alt=""><figcaption></figcaption></figure>
{% endcolumn %}

{% column %}

<p align="center"><strong>Mobile</strong></p>

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FQ8mLOTCvtUhh69EqRv06%2Fimage-20240416-044225.png?alt=media&#x26;token=217684e3-6ce9-40e6-8968-352346542b24" alt=""><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

***

## Event Page (Common) <a href="#plus" id="plus"></a>

Events commonly use the same APIs.

APIs needed for events beyond these are described separately.

<div align="center"><img src="https://tech.x2bee.com/download/attachments/266109587/FO%20API%20%ED%99%9C%EC%9A%A9%ED%95%98%EA%B8%B0-%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EB%A6%AC%EC%8A%A4%ED%8A%B8.drawio.png" alt=""></div>

### 1. List Lookup <a href="#id-1" id="id-1"></a>

You can look up the event list using various conditions, such as display period, display status, and progress status.

The results include the registered events' images, titles, and schedule information.

-Applicable event types: general entry / comment / attendance check / purchase gift / coupon download<br>

* **Look up event list(**[🔗View API >](https://api.x2bee.com/content?msa=event\&depth=%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%A1%B0%ED%9A%8C/getEventList))\
  Looks up events matching conditions such as display period, display status, and progress status.

```
GET /v1/marketing/getEventList 
```

### 2. Event Detail Lookup <a href="#id-2" id="id-2"></a>

You can look up detailed event information. Use this API to look up detailed information for general entry, comment, attendance check, purchase gift, and coupon download events.

* **Look up event details (**[🔗View API >](https://api.x2bee.com/content?msa=event\&depth=%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%A1%B0%ED%9A%8C/getEventDetail))\
  Looks up detailed information about the event.

```
GET /v1/marketing/getEventDetail 
```

### 3. Event Entry <a href="#id-3" id="id-3"></a>

The API for entering any event type provided by X2BEE. Use this API to enter general entry, comment, attendance check, purchase gift, coupon download, and survey events, among other types.

* **Integrated event entry(**[🔗View API >](https://api.x2bee.com/content?msa=event\&depth=%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%9D%91%EB%AA%A8/registerEvent))
  * Provides an event entry format for each of the following event types:
    * Drawing events: simple click, survey, comment, purchaser drawing
    * Non-drawing events: attendance check, purchase gift, coupon download, roulette

```
POST /v1/marketing/registerEvent 
```

<div align="center"><img src="https://tech.x2bee.com/download/attachments/266109587/FO%20API%20%ED%99%9C%EC%9A%A9%ED%95%98%EA%B8%B0%20-%20%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%9C%A0%ED%98%95.drawio.png" alt=""></div>

{% hint style="info" %}
Describes how the “Look up event details” and “Event entry” APIs behave depending on the event type.\
For the API for the following event types, please refer to Event Page (Common)
{% endhint %}

### 4. Attendance Check Event <a href="#id-4" id="id-4"></a>

**4.1 Look Up Attendance Check Event Details**

You can look up the event's basic information, the customer's attendance check information, and the number of times attendance has already been checked.

**4.2 Enter**\
Clicking the \[Check In] button processes attendance and grants the benefit.

### 5. Purchase Gift Event <a href="#id-5" id="id-5"></a>

**5.1 Look Up Purchase Gift Event Details**

You can look up the event's basic information and the member's order information list to check whether the specified target amount has been reached.

**5.2 Enter**

Once your purchase amount meets the event conditions, you can click the \[Enter] button to enter the event.

### 6. Comment Event <a href="#id-6" id="id-6"></a>

**6.1 Look Up Comment Event Details**

You can look up the comment event's basic information and the list of registered comments.

**6.2 Register (Enter)**

Once a comment is entered in that event's comment field, the \[Register] button becomes active; clicking it registers the comment and enters the event at the same time.

### 7. Coupon Event <a href="#id-7" id="id-7"></a>

**7.1 Look Up Coupon Event Details**

You can look up the coupon event's basic information.

**7.2 Download Coupon**

Clicking the \[Download] button for a coupon registered to that event downloads the coupon.

### 8. Roulette Event <a href="#id-8" id="id-8"></a>

**8.1 Look Up Event Details**

You can look up the roulette event's basic information.

**8.2 Enter the Event**

You can participate in a roulette event by clicking the \[START] button, and immediately receive the prize based on the winning result.

### 9. Purchaser Drawing Event <a href="#id-9" id="id-9"></a>

**9.1 Look Up Event Details**

You can look up the event's basic information and the member's order information list to check whether the specified target amount has been reached. The screen is the same as the purchase gift event.

**9.2 Enter the Event**

Clicking the \[Enter] button registered for that event completes the entry.

{% hint style="info" %}
The difference between **5. Purchase Gift Event** and **9. Purchaser Drawing Event** is as follows, being non-drawing and drawing events respectively:

* Purchase gift: After reaching the target amount and entering the event, the winner is determined and the gift is provided\
  \*<mark style="color:$danger;">14 days after</mark> the event end date\
  \*<mark style="color:$danger;">The winner determination and gift provision date can be set by the operator.</mark>
* Purchaser drawing: After reaching the target amount and entering the event, the operator carries out a winner drawing process and provides the prize to the winner
  {% endhint %}

***

## Comment Event - Edit/Delete Comment <a href="#plus" id="plus"></a>

Provides a feature for logged-in users to participate in comment events and view comments.

<div align="center"><img src="https://tech.x2bee.com/download/attachments/266109587/FO%20API%20%ED%99%9C%EC%9A%A9%ED%95%98%EA%B8%B0-%EB%8C%93%EA%B8%80%20%EC%9D%B4%EB%B2%A4%ED%8A%B8.drawio.png" alt=""></div>

### 1. View More Comments <a href="#id-1" id="id-1"></a>

* **Look up event comments (**[🔗View API >](https://api.x2bee.com/content?msa=event\&depth=%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%A1%B0%ED%9A%8C\&path=getEventReplies))\
  Looks up the list of comments written for the event number, with pagination.

```
GET/v1/marketing/getEventReplies 
```

***

## Survey Event - List and Detail Page <a href="#plus" id="plus"></a>

The survey event can be accessed via customer reviews.

<div align="center"><img src="https://tech.x2bee.com/download/attachments/266109587/FO%20API%20%ED%99%9C%EC%9A%A9%ED%95%98%EA%B8%B0-%EC%84%A4%EB%AC%B8%20%EC%9D%B4%EB%B2%A4%ED%8A%B8.drawio.png" alt=""></div>

### 1. Survey Event List <a href="#id-1" id="id-1"></a>

You can create a list by looking up the status, title, and period information of registered survey events.

* **Look up event customer review (survey) list (**[🔗View API >](https://api.x2bee.com/content?msa=event\&depth=%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%A1%B0%ED%9A%8C/getCustReviewList))\
  Looks up events registered in the BO.

```
GET /v1/marketing/getCustReviewList 
```

### 2. Survey Event Detail Page <a href="#id-2" id="id-2"></a>

You can look up the detailed content of the survey event and select and click items.

* **Look up event customer review (survey) details (**[🔗View API >](https://api.x2bee.com/content?msa=event\&depth=%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%A1%B0%ED%9A%8C/getCustReviewDetail))\
  Looks up the survey event's content and questions.

```
GET /v1/marketing/getCustReviewDetail 
```

### 3. Survey Event Entry <a href="#id-3" id="id-3"></a>

Once a survey selection is complete, the Enter button becomes active.

Clicking the \[Enter] button completes the entry.

For the survey event entry API, please refer to 3. Event Entry in the event document.

***

## Event Participation History Page <a href="#plus" id="plus"></a>

You can check information about events the customer has participated in.

<div align="center"><img src="https://tech.x2bee.com/download/attachments/266109587/FO%20API%20%ED%99%9C%EC%9A%A9%ED%95%98%EA%B8%B0%20-%20%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%B0%B8%EC%97%AC%EB%82%B4%EC%97%AD.drawio.png" alt=""></div>

### 1. Event Participation History <a href="#id-1" id="id-1"></a>

Customers can view a list of their event participation history.

* **Look up event participation history (**[🔗View API >](https://api.x2bee.com/content?msa=event\&depth=%EC%9D%B4%EB%B2%A4%ED%8A%B8%20%EC%B0%B8%EC%97%AC%EB%82%B4%EC%97%AD\&path=getMyEventEntryList))\
  Looks up the history of events participated in.

```
GET /v1/marketing/getMyEventEntryList 
```