# Flaunt Klaviyo Profile Properties and Events

## Profile Properties

| Profile Property Name | Type | Description |
| ------------------------------ | ------------------------------------------------- | ------------------------------------------- |
| flauntloyalty_birthday | Date | Birthday of Loyalty Account |
| flauntloyalty_tier | String | Current Tier in Loyalty Program |
| flauntloyalty_anniversary_date | Date | Date User Was First Seen in Loyalty Program |
| flauntloyalty_challenges | [Array of Challenges ](#flauntloyalty_challenges) | Array of Challenges |
| flauntloyalty_active_rewards | [Array of Rewards](#flauntloyalty_rewards) | Currently Available Rewards for User |
| flauntloyalty_available_points | Number | Currently Available Points for User |
| flauntloyalty_pending_points | Number | Currently Pending Points for User |

### <a name="flauntloyalty_challenges">flauntloyalty_challenges</a>
| Key | Type | Description |
| --------------- | ---------------------------- | ------------------------------------------------ |
| name | String | Name of Challenge |
| complete | Boolean | Has challenge been completed/redeemed |
| completedAt | Date | Date/Time User completed challenge |
| totalActions | Number | Total Number of Actions in Challenge |
| actionsComplete | Number | Total Number of Actions User has completed |
| image | String | Cover Image of Challenge |
| actions | [Array of Actions](#actions) | Array of Tasks/Actions in Challenge and progress |

#### <a name="actions">actions</a>
| Key | Type | Description |
| --------------- | ------ | --------------------------- |
| id | String | Flaunt Action ID |
| name | String | Name of Challenge Action |
| percentProgress | Number | Progress Complete on Action |

Example Entry:

[
  {
    "name": "Write A Review",
    "complete": true,
    "completedAt": "2024-03-25T15:03:33.738Z",
    "totalActions": 3,
    "actionsComplete": 3,
    "image": "https://firebasestorage.googleapis.com/v0/b/flaunt-v1.appspot.com/o/creators%2FNSC-Reviews-Challenge-2.jpg_1708368573171?alt=media&token=874b1581-1090-4100-9e7b-da8788408b14",
    "actions": [
      {
        "id": "clstalsxs0001eof2ex4v7cgo",
        "name": "Review a product you've purchased",
        "percentProgress": 100
      },
      {
        "id": "clstalsxs0002eof277dobh88",
        "name": "Review a second product you've purchased",
        "percentProgress": 100
      },
      {
        "id": "clstalsxs0003eof2whmmx6wx",
        "name": "Review a third product you've purchased (click 'Claim your reward' to get the full 2,000 point bonus!)",
        "percentProgress": 100
      }
    ]
  }
]

---
### <a name="flauntloyalty_rewards">flauntloyalty_rewards</a>

| Key | Type | Description |
| ----------- | ------ | --------------------- |
| name | String | Name of Reward |
| description | String | Description of Reward |
| image | String | URL of Reward |
| startDate | Date | When Reward Starts |
| endDate | Date | When Reward Expires |
| category | String | Category of Reward |

[
  {
    "name": "Enthusiast: 10% off",
    "description": "Unlock 10% off as a sign of our gratitude for your enthusiasm. Remember all reward codes are one-time use and will expire on 12/31/24.\n\nCannot be combined with other offers.",
    "image": "https://firebasestorage.googleapis.com/v0/b/flaunt-v1.appspot.com/o/creators%2FDSC00537%20(1).jpg_1698421519682?alt=media&token=88577682-83b7-4d44-8bb7-75427a22cbe8",
    "startDate": "2023-10-27T15:46:00.000Z",
    "endDate": "2025-01-01T04:59:00.000Z",
    "category": "DISCOUNT"
  }
]

## Events

### Create Account

Event Name: "Flaunt Loyalty: Created Account"

Included Properties:

flauntloyalty_benefits: {
  flauntloyalty_reward_name: string;
  flauntloyalty_reward_image?: string;
}[]

### Tier Upgrade

Event Name: "Flaunt Loyalty: Tier Upgrade"

Included Properties:

flauntloyalty_tier_name: string;
flauntloyalty_benefits: {
  flauntloyalty_reward_name: string;
  flauntloyalty_reward_image?: string;
}[];

### Abandoned Challenge
Event Name: "Flaunt Loyalty: Abandoned Challenge"

Included Properties:

{
    flauntloyalty_challenge_name: string,
    flauntloyalty_challenge_image: string,
    flauntloyaltyChallenge_steps_remaining: number,
    flauntloyalty_benefits: {
      flauntloyalty_reward_name: string;
      flauntloyalty_reward_image?: string;
    }[]
    flauntloyalty_points_amt: number;
}

### Expiring Benefits
Event Name: "Flaunt Loyalty: Expiring Benefits"

Included Properties:

{
    flauntloyalty_reward_name: string, 
    flauntloyalty_reward_image: string
}

### Reward Available
Event Name: "Flaunt Loyalty: Reward Available"

Included Properties:

{
  flauntloyalty_reward_id: reward.id,
  flauntloyalty_reward_name: reward.name,
  flauntloyalty_reward_description: reward.description,
  flauntloyalty_reward_image: reward.image,
  flauntloyalty_reward_startDate: reward.startDate,
  flauntloyalty_reward_endDate: reward.endDate,
  flauntloyalty_reward_category: reward.category,
  flauntloyalty_discount_code: reward.discountCode
}