Skip to contentSkip to navigationSkip to topbar
Page toolsOn this page
Looking for more inspiration?Visit the
(information)
You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

Wecheer Source


Source Info
  • The Wecheer Source is an Event Cloud source. This means that it sends data as events, which are behaviors or occurrences tied to a user and a point in time. Data from these sources can be loaded into your Segment warehouses, and also sent to Segment streaming destinations. Learn more about cloud sources.
  • This source is in Beta

Wecheer(link takes you to an external page) is a customer-engagement platform for consumer goods brands selling through third-party points of sale.

This is an Event Cloud Source which exports data into your Segment warehouse and also federates the exported data into your other enabled Segment destinations.

Wecheer maintains this source. For any issues with the source, contact the Wecheer Support team.


Getting started

getting-started page anchor
  1. From your workspace's Sources catalog page(link takes you to an external page), click Add Source.
  2. Search for Wecheer in the Sources Catalog, select Wecheer, and click Add Source.
  3. Give the source a name and 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 Segment recommends using something that reflects the source itself and distinguishes amongst your environments (for example, Wecheer_Prod, Wecheer_Staging, Wecheer_Dev).
  4. Click Add Source to save your settings.
  5. From your Wecheer settings page in the Segment UI, copy your write key.
  6. Log in to your Wecheer account and navigate to Campaigns > Advertisers > Advertiser Details > Advertiser Settings > Outbound Events > Choose Provider > Segment and paste the key to connect.
  7. Select the list of events that you want to subscribe to.
  8. Click Save configuration.

Wecheer uses this Segment Event Cloud Source to send Wecheer event data to Segment. 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
  • Written into the schema that Segment creates for this source in your data warehouse, so you can query them using SQL.

The following table lists all event types that Wecheer Campaigns can send to Segment when you configure outbound events at the Advertiser or Campaign level.

Each of these events is sent as a Segment Track call with the Event Name as the event value.

Event nameDescription
Card ReceivedUser receives a loyalty card
Card GivenCard issued to user
No Campaign JoinedUser has no active campaign
ConsumptionGeneral consumption event
Consumption MatchConsumption matches criteria
First ConsumptionUser's first purchase
Any ConsumptionAny consumption occurred
First Consumption GivenFirst purchase reward given
Any Consumption GivenAny consumption reward given
Scan ReceiptReceipt scan initiated
Receipt ScannedReceipt successfully scanned
Receipt TriagedReceipt moved to triage
Receipt FailedReceipt processing failed
Receipt FraudFraudulent receipt detected
Receipt IncompleteReceipt data incomplete
Receipt No RewardReceipt doesn't qualify for reward
Receipt Manual Review Limit ExceededManual review queue full
Stamps GivenStamps awarded to user
Manual Give StampsStamps manually added
Punchcard Stamps ReceivedUser receives punchcard stamps
Stamps Limit ReachedUser reached stamp limit
Stamps OverflowStamps exceed limit
Punchcard CompletedPunchcard fully completed
Punchcard Step CompletedPunchcard step achieved
Punchcard Already CompletedDuplicate completion attempt
Reward ReceivedUser receives reward
Birthday Reward ReceivedBirthday reward given
Level Unlock Reward ReceivedLevel-up reward given
Validate RewardReward validation performed
Points ReceivedUser receives points
No Point ReceivedNo points awarded
Lucky Draw ReceivedUser receives lucky draw entry
User Data SharedUser shares personal data
Game TriggeredGame initiated
Game CompletedGame finished
Level UnlockedUser unlocks new level
Safe Box GeneratedSafeBox created
Safe Box ReadSafeBox accessed
Safe Box RedeemedSafeBox redeemed
Catalog RedeemCatalog item redeemed
Products Limit ReachedProduct limit hit
Staff Products GivenStaff issues product
Manual Verification RequestedManual review requested
Manual Verification ApprovedManual review approved
Manual Verification RejectedManual review rejected
Consumer Referral Invite GeneratedConsumer referral created
Staff Referral Invite GeneratedStaff referral created
Init Staff Point CardStaff point card initialized
Handshake QR ValidValid QR code scanned
Handshake QR InvalidInvalid QR code scanned
Data Consumer SyncConsumer data synchronized
Advertiser Consumption TransactionTransaction recorded

The following table lists the properties included in the events listed above:

Property nameDescription
user_idID of the user
advertiser_idBrand ID
campaign_idCampaign ID

Once your Source is set up, you can connect it with destinations.

Log in to 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 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.