Skip to content

Commit 0d4f810

Browse files
stayseesongstayseesong
authored
Apply suggestions from code review
1 parent e33eacd commit 0d4f810

File tree

1 file changed

+59
-59
lines changed
  • src/connections/sources/catalog/cloud-apps/livelike-source

1 file changed

+59
-59
lines changed

‎src/connections/sources/catalog/cloud-apps/livelike-source/index.md

Lines changed: 59 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@ id: EjYD7n6dOa
77

88
This integration will enable you to receive related engagement and achievements from LiveLike into your Segment warehouse, which can enable and enhance your automated marketing tacics and capabilities as well as augment your analytics and first-party data for your users.
99

10-
This source is maintained by LiveLike. For any issues with the source, [contact their Support team](mailto:[email protected]).
10+
This source is maintained by LiveLike. For any issues with the source, [contact the LiveLike Support team](mailto:[email protected]).
1111

1212
## Getting started
1313

1414
1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**.
15-
2. Search for "LiveLike" in the Sources Catalog, select LiveLike, and click **Add Source**.
16-
3. On the next screen, give the Source a nickname configure any other settings.
15+
2. Search for *LiveLike* in the Sources Catalog. Select **LiveLike**, and click **Add Source**.
16+
3. Give the Source a name and configure any other settings.
1717

18-
- The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. LiveLike_Prod, LiveLike_Staging, LiveLike_Dev).
18+
- 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, LiveLike_Prod, LiveLike_Staging, LiveLike_Dev).
1919

2020
4. Click **Add Source** to save your settings.
21-
5. Copy the Write key from the Segment UI.
22-
6. In order to enable the integration, provide thhis Write Key to your LiveLike Account Manager so that LiveLike staff can input that Write Key into the platform to complete the process.
21+
5. Copy the **Write Key** from the Segment UI.
22+
6. Provide the write Key to your LiveLike Account Manager so that LiveLike staff can input that write key into the platform to complete the process and enable the integration.
2323

2424
## Stream
2525

26-
LiveLike uses our stream Source component to send Segment event data. It uses a server-side `track` method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.
26+
LiveLike uses Segment's stream Source component to send Segment event data. It uses a server-side `track` method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL.
2727

2828
The default behavior is for LiveLike to pass the userId associated with the event, which usually is your already-known userId, as well as a LiveLike User Profile ID as livelike_profile_id inside the Properties object within the Track event payload.
2929

@@ -33,102 +33,102 @@ The table below lists events that LiveLike sends to Segment. These events appear
3333

3434
| Event Name | Description |
3535
| ------------------ | ------------------------------------- |
36-
| Badge Rewarded | When a user receives a badge |
37-
| Quest Task Completed | When a user completes a Quest Task |
38-
| Quest Reward Awarded | When a user receives a Reward Item via a Quest Completion |
39-
| Reward Item Rewarded | When a user is rewarded via a Reward Table |
40-
| User Quest Task Progressed | When a user progresses a Quest Task |
41-
| User Quest Completed | When a user completes a Quest |
36+
| Badge Rewarded | When a user receives a badge. |
37+
| Quest Task Completed | When a user completes a Quest Task. |
38+
| Quest Reward Awarded | When a user receives a Reward Item via a Quest Completion. |
39+
| Reward Item Rewarded | When a user is rewarded via a Reward Table. |
40+
| User Quest Task Progressed | When a user progresses a Quest Task. |
41+
| User Quest Completed | When a user completes a Quest. |
4242

4343
## Event Properties for Badge Rewarded
4444

4545
The table below list the properties included in the events listed above.
4646

4747
| Property Name | Description |
4848
| --------------- | ------------------------- |
49-
| `livelike_profile_id` | Profile ID of the LiveLike user |
50-
| `badge_id` | ID of the specific Badge the user earned |
51-
| `badge_title` | Title of the specific Badge the user earned |
52-
| `description` | Description of the specific Badge the user earned |
53-
| `earned_badge_id` | ID of the specific transaction of the user earning the Badge |
54-
| `image_url` | URL of the Badge image |
55-
| `reward_item_id` | ID of the Reward Item that's associated to the threshold to earn the Badge |
56-
| `reward_item_name` | Name of the Reward Item that's associated to the threshold to earn the Badge |
57-
| `reward_item_threshold` | Threshold amount of the Reward Item that's associated to earning the Badge |
49+
| `livelike_profile_id` | The profile ID of the LiveLike user. |
50+
| `badge_id` | The ID of the specific Badge the user earned. |
51+
| `badge_title` | The title of the specific Badge the user earned. |
52+
| `description` | The description of the specific Badge the user earned. |
53+
| `earned_badge_id` | The ID of the specific transaction of the user earning the Badge. |
54+
| `image_url` | The URL of the Badge image. |
55+
| `reward_item_id` | The ID of the Reward Item that's associated to the threshold to earn the Badge. |
56+
| `reward_item_name` | The name of the Reward Item that's associated to the threshold to earn the Badge. |
57+
| `reward_item_threshold` | The threshold amount of the Reward Item that's associated to earning the Badge. |
5858

5959
## Event Properties for Quest Task Completed
6060

6161
The table below list the properties included in the events listed above.
6262

6363
| Property Name | Description |
6464
| --------------- | ------------------------- |
65-
| `livelike_profile_id` | Profile ID of the LiveLike user |
66-
| `quest_id` | ID of the Quest |
67-
| `quest_name` | Name of the Quest |
68-
| `quest_task_id` | ID of the specific Task within the Quest that was completed |
69-
| `quest_task_name` | Name of the specific Task within the Quest that was completed |
70-
| `user_quest_id` | ID of the specific relationship between the User and that Quest |
71-
| `user_quest_task_id` | ID of the specific relationship between the User and that Quest Task |
65+
| `livelike_profile_id` | The profile ID of the LiveLike user. |
66+
| `quest_id` | The ID of the Quest. |
67+
| `quest_name` | The name of the Quest. |
68+
| `quest_task_id` | The ID of the specific Task within the Quest that was completed. |
69+
| `quest_task_name` | The name of the specific Task within the Quest that was completed. |
70+
| `user_quest_id` | The ID of the specific relationship between the User and that Quest. |
71+
| `user_quest_task_id` | The ID of the specific relationship between the User and that Quest Task. |
7272

7373
## Event Properties for Quest Reward Awarded
7474

7575
The table below list the properties included in the events listed above.
7676

7777
| Property Name | Description |
7878
| --------------- | ------------------------- |
79-
| `livelike_profile_id` | Profile ID of the LiveLike user |
80-
| `quest_id` | ID of the Quest the user completed to earn Rewards (if applicable) |
81-
| `quest_name` | Name of the Quest the user completed to earn Rewards (if applicable) |
82-
| `reward_item_name` | Name of the Reward Item that was rewarded |
83-
| `reward_item_amount` | Amount of the Reward Item that was rewarded |
84-
| `reward_item_balance` | The new balance of the Reward Item for the user |
85-
| `reward_item_id` | ID of the Reward Item that was rewarded |
86-
| `reward_item_transaction_id` | ID of the transaction of the User being rewarded |
79+
| `livelike_profile_id` | The profile ID of the LiveLike user. |
80+
| `quest_id` | The ID of the Quest the user completed to earn Rewards (if applicable). |
81+
| `quest_name` | The name of the Quest the user completed to earn Rewards (if applicable). |
82+
| `reward_item_name` | The name of the Reward Item that was rewarded. |
83+
| `reward_item_amount` | The amount of the Reward Item that was rewarded. |
84+
| `reward_item_balance` | The new balance of the Reward Item for the user. |
85+
| `reward_item_id` | The ID of the Reward Item that was rewarded. |
86+
| `reward_item_transaction_id` | The ID of the transaction of the User being rewarded. |
8787

8888
## Event Properties for Reward Item Rewarded
8989

9090
The table below list the properties included in the events listed above.
9191

9292
| Property Name | Description |
9393
| --------------- | ------------------------- |
94-
| `livelike_profile_id` | Profile ID of the LiveLike user |
95-
| `reward_item_name` | Name of the Reward Item that was rewarded |
96-
| `reward_item_amount` | Amount of the Reward Item that was rewarded |
97-
| `reward_item_balance` | The new balance of the Reward Item for the user |
98-
| `reward_item_id` | ID of the Reward Item that was rewarded |
99-
| `reward_item_transaction_id` | ID of the transaction of the User being rewarded |
94+
| `livelike_profile_id` | The profile ID of the LiveLike user. |
95+
| `reward_item_name` | The name of the Reward Item that was rewarded. |
96+
| `reward_item_amount` | The amount of the Reward Item that was rewarded. |
97+
| `reward_item_balance` | The new balance of the Reward Item for the user. |
98+
| `reward_item_id` | The ID of the Reward Item that was rewarded. |
99+
| `reward_item_transaction_id` | The ID of the transaction of the User being rewarded. |
100100

101101
## Event Properties for User Quest Task Progressed
102102

103103
The table below list the properties included in the events listed above.
104104

105105
| Property Name | Description |
106106
| --------------- | ------------------------- |
107-
| `livelike_profile_id` | Profile ID of the LiveLike user |
108-
| `quest_id` | ID of the Quest |
109-
| `quest_name` | Name of the Quest |
110-
| `quest_task_id` | ID of the specific Task within the Quest that was completed |
111-
| `quest_task_name` | Name of the specific Task within the Quest that was completed |
112-
| `quest_task_target_value` | Target number of times this Task needs to be done to complete the Task |
113-
| `user_quest_id` | ID of the specific relationship between the User and that Quest |
114-
| `user_quest_task_id` | ID of the specific relationship between the User and that Quest Task |
115-
| `user_quest_task_progress` | Number of times this Task has been done so far |
107+
| `livelike_profile_id` | The profile ID of the LiveLike user. |
108+
| `quest_id` | The ID of the Quest. |
109+
| `quest_name` | The name of the Quest. |
110+
| `quest_task_id` | The ID of the specific Task within the Quest that was completed. |
111+
| `quest_task_name` | The name of the specific Task within the Quest that was completed. |
112+
| `quest_task_target_value` | The target number of times this Task needs to be done to complete the Task. |
113+
| `user_quest_id` | The ID of the specific relationship between the User and that Quest. |
114+
| `user_quest_task_id` | The ID of the specific relationship between the User and that Quest Task. |
115+
| `user_quest_task_progress` | The number of times this Task has been done so far. |
116116

117117
## Event Properties for User Quest Completed
118118

119119
The table below list the properties included in the events listed above.
120120

121121
| Property Name | Description |
122122
| --------------- | ------------------------- |
123-
| `livelike_profile_id` | Profile ID of the LiveLike user |
124-
| `quest_id` | ID of the Quest |
125-
| `quest_name` | Name of the Quest |
126-
| `user_quest_id` | ID of the specific relationship between the User and that Quest |
123+
| `livelike_profile_id` | The profile ID of the LiveLike user. |
124+
| `quest_id` | The ID of the Quest. |
125+
| `quest_name` | The name of the Quest. |
126+
| `user_quest_id` | The ID of the specific relationship between the User and that Quest. |
127127

128128
## Adding Destinations
129129

130-
Now that your Source is set up, you can connect it with Destinations.
130+
Once your Source is set up, you can connect it with Destinations.
131131

132-
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.
132+
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](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
133133

134-
If there are any issues with how the events are arriving to Segment, [contact the LiveLike support team](mailto:[email protected]).
134+
If there are any issues with how the events arrive to Segment, [contact the LiveLike support team](mailto:[email protected]).

0 commit comments

Comments
 (0)