Skip to content

Add Wecheer source docs #8179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
toan-wecheer wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Add Wecheer source docs #8179

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ff4005c
Add Wecheer source docs
toan-wecheer Feb 11, 2026
87b565d
Update Wecheer introduction
toan-wecheer Feb 11, 2026
d9bde5d
space fix
Feb 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 115 additions & 0 deletions src/connections/sources/catalog/cloud-apps/wecheer/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
---
title: Wecheer Source
---

[Wecheer](https://wecheer.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is a customer-engagement platform for consumer goods brands selling through third-party points of sale.

This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations.


This source is maintained by Wecheer. For any issues with the source, [contact Wecheer Support team](mailto:support@wecheer.io).

## Getting started

1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**.
2. Search for "Wecheer" in the Sources Catalog, select Wecheer, and click **Add Source**.
3. On the next screen, give the Source a name configure any other settings.

- The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev).

4. Click **Add Source** to save your settings.
5. Copy the Write key from the Segment UI.
6. Log in to your Wecheer **Campaigns** -> navigate to **Advertisers** > **Advertiser Details** > **Advertiser Settings** → **Outbound Events** → Choose Provider **Segment** and paste the key to connect. And then you need to select the list of event that you want to subscribe.
7. Click Save configuration.
8. You are also setting at **Campaign** Level in **Campaign Details** → **Main Information** → **Outbound Events** and do the same with Advertiser Level.
Copy link
Contributor

@stayseesong stayseesong Feb 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@toan-wecheer what does this line mean? What is the user setting?

Copy link
Author

@toan-wecheer toan-wecheer Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @stayseesong This one will be done in our system by our client UI

Copy link
Contributor

@stayseesong stayseesong Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ook then can I take the line out? The wording is very confusing


## Stream

Wecheer uses this Segment Event Cloud Source to send Wecheer event data to Segment in near real time from our backend services. Events are sent using Segment’s server-side methods (such as `track`, `identify`, `page`, and `group`), depending on the type of data being recorded.

Each event includes the identifiers described in the Event Properties section (for example UserId, AdvertiserId, and CampaignId), so that downstream tools and your data warehouse can reliably join Wecheer activity back to your own users, brands, and campaigns.

Once events are delivered to Segment, they are:

Forwarded to any Destinations that support server-side events, and

Written into the schema that Segment creates for this Source in your data warehouse, so you can query them using SQL.

## Events

The table below lists all event types that Wecheer Campaigns can send to Segment when you configure outbound events at Advertiser or Campaign level.
Each of these events is sent as a Segment track call with the Event Name as the event value.

| Event Name | Description |
| -------------------------------------- | ------------------------------------------------ |
| CardReceived | User receives a loyalty card |
| CardGiven | Card issued to user |
| NoCampaignJoined | User has no active campaign |
| Consumption | General consumption event |
| ConsumptionMatch | Consumption matches criteria |
| FirstConsumption | User's first purchase |
| AnyConsumption | Any consumption occurred |
| FirstConsumptionGiven | First purchase reward given |
| AnyConsumptionGiven | Any consumption reward given |
| ScanReceipt | Receipt scan initiated |
| ReceiptScanned | Receipt successfully scanned |
| ReceiptTriaged | Receipt moved to triage |
| ReceiptFailed | Receipt processing failed |
| ReceiptFraud | Fraudulent receipt detected |
| ReceiptIncomplete | Receipt data incomplete |
| ReceiptNoReward | Receipt doesn't qualify for reward |
| ReceiptManualReviewLimitExceeded | Manual review queue full |
| StampsGiven | Stamps awarded to user |
| ManualGiveStamps | Stamps manually added |
| PunchcardStampsReceived | User receives punchcard stamps |
| StampsLimitReached | User reached stamp limit |
| StampsOverflow | Stamps exceed limit |
| PunchcardCompleted | Punchcard fully completed |
| PunchcardStepCompleted | Punchcard step achieved |
| PunchcardAlreadyCompleted | Duplicate completion attempt |
| RewardReceived | User receives reward |
| BirthdayRewardReceived | Birthday reward given |
| LevelUnlockRewardReceived | Level-up reward given |
| ValidateReward | Reward validation performed |
| PointsReceived | User receives points |
| NoPointReceived | No points awarded |
| LuckyDrawReceived | User receives lucky draw entry |
| UserDataShared | User shares personal data |
| GameTriggered | Game initiated |
| GameCompleted | Game finished |
| LevelUnlocked | User unlocks new level |
| SafeBoxGenerated | SafeBox created |
| SafeBoxRead | SafeBox accessed |
| SafeBoxRedeemed | SafeBox redeemed |
| CatalogRedeem | Catalog item redeemed |
| ProductsLimitReached | Product limit hit |
| StaffProductsGiven | Staff issues product |
| ManualVerificationRequested | Manual review requested |
| ManualVerificationApproved | Manual review approved |
| ManualVerificationRejected | Manual review rejected |
| ConsumerReferralInviteGenerated | Consumer referral created |
| StaffReferralInviteGenerated | Staff referral created |
| InitStaffPointCard | Staff point card initialized |
| HandshakeQRValid | Valid QR code scanned |
| HandshakeQRInValid | Invalid QR code scanned |
| DataConsumerSync | Consumer data synchronized |
| AdvertiserConsumptionTransaction | Transaction recorded |

## Event Properties

The table below lists the properties included in the events listed above.

| Property Name | Description |
| -------------- | ------------------ |
| `UserId` | ID of the user |
| `AdvertiserId` | Brand Id |
| `CampaignId` | Campaign Id |


## Adding Destinations

Now that your Source is set up, you can connect it with Destinations.

Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.

If there are any issues with how the events are arriving to Segment, [contact the Wecheer support team](mailto:support@wecheer.io).