Wecheer Integration

Build powerful loyalty and engagement integrations with the Wecheer platform. Send events, sync profiles, and receive real-time data.

┌───────────────────────────────────────────────────────────────────────┐
│                            YOUR SYSTEMS                               │
│  ┌─────────┐  ┌─────────┐  ┌─────────┐  ┌─────────┐                 │
│  │   CRM   │  │   CDP   │  │Analytics│  │  E-com  │                 │
│  └─────────┘  └─────────┘  └─────────┘  └─────────┘                 │
└──────┬──────────────────────────┬──────────────────────────┬──────────┘
       │ Outbound                 │ Inbound                  │ Inbound
       │ (Wecheer → You)          │ (via Segment)            │ (via API)
       ▲                          ▼                          ▼
┌──────┴──────────┐    ┌──────────┴──────────┐   ┌──────────────────┐
│    SEGMENT      │    │     SEGMENT         │   │   WECHEER API    │
│   (Outbound)    │    │    (Inbound)        │   │    (Inbound)     │
└──────┬──────────┘    └──────────┬──────────┘   └────────┬─────────┘
       └──────────────────────────┴──────────────────────┐ │
                                                         ▼ ▼
┌───────────────────────────────────────────────────────────────────────┐
│                        WECHEER PLATFORM                               │
│  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐                  │
│  │  Campaigns  │  │   Rewards   │  │    Users    │                  │
│  └─────────────┘  └─────────────┘  └─────────────┘                  │
└───────────────────────────────────────────────────────────────────────┘

Integration via Segment

Wecheer uses Segment as its outbound event delivery middleware. When users interact with your campaign, Wecheer streams real-time events into your Segment workspace.

┌───────────────────────────────────────────────────────────────────────┐
│                        WECHEER PLATFORM                               │
│  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐                  │
│  │  User Joins │  │   Scans     │  │   Redeems   │                  │
│  │  Campaign   │  │   Product   │  │   Reward    │                  │
│  └──────┬──────┘  └──────┬──────┘  └──────┬──────┘                  │
│         └────────────────┼────────────────┘                          │
│                          ▼                                            │
│                 ┌─────────────────┐                                  │
│                 │  Event Stream   │                                  │
│                 └────────┬────────┘                                  │
└──────────────────────────┼───────────────────────────────────────────┘
                           ▼
              ┌─────────────────────────┐
              │        SEGMENT          │
              └─────────────┬───────────┘
        ┌────────────────────┼────────────────────┐
        ▼                    ▼                    ▼
┌───────────────┐   ┌───────────────┐   ┌───────────────┐
│   Your CRM    │   │   Your CDP    │   │  Analytics    │
└───────────────┘   └───────────────┘   └───────────────┘

Integration via Segment Source

The recommended approach for most clients. Wecheer will be onboarded as a Source in your Segment workspace and will automatically forward all campaign events in real time.

Wecheer Platform
      │
      │ track() calls
      ▼
Segment Source (Wecheer)
      │
      ├──► Salesforce CRM
      ├──► BigQuery / Snowflake
      ├──► Braze / Iterable
      └──► Any Segment Destination

Integration via Segment Function

Use a Segment Function when you need to transform Wecheer events before forwarding them, or when your destination is not available in the Segment catalog.

Wecheer Platform
      │
      │ track() calls
      ▼
Segment Source (Wecheer)
      │
      ▼
Segment Function
(Your transformation logic)
      │
      ▼
Your Custom Endpoint / System

In your Segment workspace, go to Connections → Catalog → Functions and create a new Destination Function.

Implement your event handling logic in JavaScript. The function receives a Segment event object and can forward it to any HTTP endpoint.

async function onTrack(event, settings) {
  const payload = {
    eventName: event.event,
    userId: event.userId,
    timestamp: event.timestamp,
    properties: event.properties
  };

  const response = await fetch(settings.destinationUrl, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${settings.apiToken}`
    },
    body: JSON.stringify(payload)
  });

  if (!response.ok) {
    throw new Error(`Request failed: ${response.status}`);
  }
}

In Segment, connect your newly created Function as a Destination of the Wecheer Source. Configure any required settings (e.g. destination URL, API token).

Use Segment's Function testing tools to send sample Wecheer events through your function and verify the output before going live.

Event Scheme

Wecheer emits three categories of Segment events. All events follow the standard Segment track structure with Wecheer-specific properties.

{
  "type": "track",
  "event": "EventName",
  "userId": "user-uuid-12345",
  "timestamp": "2026-01-15T12:34:56.789Z",
  "properties": { },
  "context": { "source": "wecheer", "version": "1.0" }
}

{
  "type": "track",
  "event": "points_received",
  "userId": "user-uuid-12345",
  "timestamp": "2026-01-15T12:34:56.789Z",
  "properties": {
    "eventId": "evt-uuid-12345",
    "campaignId": "camp-12345",
    "points": 150,
    "reason": "product_scan",
    "previousBalance": 1000,
    "newBalance": 1150
  }
}

{
  "type": "track",
  "event": "user_created",
  "userId": "user-uuid-12345",
  "properties": {
    "email": "user@example.com",
    "phone": "+1234567890",
    "registrationSource": "campaign_link",
    "campaignId": "camp-12345",
    "marketingConsent": true
  }
}

{
  "type": "track",
  "event": "CatalogRedeem",
  "userId": "user-uuid-12345",
  "properties": {
    "redemptionId": "redeem-uuid-12345",
    "rewardId": "reward-uuid-12345",
    "rewardName": "Coffee Voucher",
    "cost": { "points": 500 },
    "voucherCode": "COFFEE-ABC123"
  }
}

Integration via API (Webhook)

Integration via Segment Destination

Your Systems (Mobile App, Web, Backend)
      │
      │ Segment track() / identify()
      ▼
Your Segment Workspace
      │
      ▼
Wecheer Destination (Segment Catalog)
      │
      ▼
Wecheer Platform (Rewards & Campaigns)

Integration via API

Send events directly to Wecheer using the Inbound API. This is the primary integration method for triggering rewards, processing user actions, and syncing data from your systems.

┌─────────────────────────────────────────────────────────────────┐
│                        YOUR SYSTEMS                              │
│  ┌─────────┐  ┌─────────┐  ┌─────────┐  ┌─────────┐            │
│  │  E-com  │  │   CRM   │  │   App   │  │   POS   │            │
│  └────┬────┘  └────┬────┘  └────┬────┘  └────┬────┘            │
└───────┼────────────┼────────────┼────────────┼──────────────────┘
        └────────────┴─────┬──────┴────────────┘
                           ▼
                    ┌─────────────┐
                    │   Wecheer   │
                    │  Inbound    │
                    │    API      │
                    └─────────────┘

User Conditions for Receiving Rewards

Before a user can receive rewards through the Wecheer platform, the following conditions must be met.

Authorize Endpoint

Used to authenticate the client and provide a token that authorizes requests to other endpoints.

curl -X 'POST' \
  'https://api.wecheer.me/staging-usermanagement/api/advertiser/v1/authorize' \
  -H 'accept: text/plain' \
  -H 'apiKey: 7f2156c3-d398478b-854632efc7cade1b' \
  -H 'apiSecret: 3DpcdDQca8p3lZXQ1BoNBiGNlA3ZnCFjZYstElG0WHVMv13E87mrYPXdMj4hgIsM' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
  "advertiserId": "1000112586"
}'

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "advertiserId": "1000112586"
}

Consumption Endpoint

Used to process dynamic events based on configured SKUs from the platform, synthetically created to reflect user actions.

{
  "consumptionId": "I198037776491223",
  "consumptionDate": "20250425T12:34:00Z",
  "identifiers": [
    {
      "key": "phoneNumber",
      "value": "40720005123"
    },
    {
      "key": "email",
      "value": "user@example.com"
    }
  ],
  "consumptionLines": [
    {
      "sku": "velo_pk_poll_strength",
      "quantity": 1
    }
  ]
}

curl -X 'POST' \
  'https://api.wecheer.me/staging-campaigns/api/advertiser-integration/v1/consumption' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
  "consumptionId": "I198037776491223",
  "consumptionDate": "20250425T12:34:00Z",
  "identifiers": [
    { "key": "phoneNumber", "value": "40720005123" },
    { "key": "email", "value": "user@example.com" }
  ],
  "consumptionLines": [
    { "sku": "velo_pk_poll_strength", "quantity": 1 }
  ]
}'

Integration Responsibilities

Getting your integration live is a team effort - and we've made our part as lightweight as possible.

Via Segment Source Recommended

Via Segment Function

Via API

Status Codes & Errors

HTTP status codes and error responses from the Wecheer API.

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error description",
    "details": { }
  }
}

Rate Limits

API throttling policies and best practices for handling limits.

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 295
X-RateLimit-Reset: 1705320000

async function requestWithBackoff(fn, maxRetries = 5) {
  for (let i = 0; i < maxRetries; i++) {
    const response = await fn();

    if (response.status === 429) {
      const retryAfter = response.headers.get('Retry-After') || 60;
      await sleep(retryAfter * 1000);
      continue;
    }

    return response;
  }
}

Security & Compliance

Enterprise-grade security practices and certifications.

Glossary

Definitions of key terms used throughout the Wecheer platform.