Skip to content

Commit 2c736ac

Browse files
laliconfigcatlaliconfigcat
committed
Documentation progress
1 parent d810e0d commit 2c736ac

File tree

1 file changed

+41
-9
lines changed
  • src/connections/sources/catalog/cloud-apps/configcat

1 file changed

+41
-9
lines changed

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

Lines changed: 41 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,52 +12,84 @@ This source is maintained by ConfigCat. For any issues with the source, [contact
1212

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

1717
- 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. ConfigCat_Prod, ConfigCat_Staging, ConfigCat_Dev).
1818

1919
4. Click **Add Source** to save your settings.
2020
5. Copy the Write key from the Segment UI.
21-
6. Log in to the ConfigCat Dashboard and copy the SDK Key for your Config in the specific Environment.
22-
7. In your application's code **Configure SDKs:**:
21+
22+
### Sending feature flag change events from ConfigCat to Twilio Segment
23+
24+
1. Open the [integrations tab](https://app.configcat.com/product/integrations){:target="_blank”} on the ConfigCat Dashboard.
25+
2. Click on Twilio Segment's CONNECT button and set the Twilio Segment Write Key acquired while adding the ConfigCat source in Segment.
26+
3. OPTIONAL - Set the proper server of your Twilio Segment account.
27+
4. You're all set. Go ahead and make some changes on your feature flags then check your events in Twilio Segment.
28+
29+
### Sending feature flag evaluation analytics from ConfigCat to Twilio Segment
30+
31+
1. Log in to the ConfigCat Dashboard and copy the SDK Key for your Config in the specific Environment.
32+
2. In your application's code **Configure SDKs:**:
2333
- **ConfigCat SDK:** Initialize with your ConfigCat SDK key.
24-
- **Segment SDK:** Set up with the Segment write token acquired while adding the ConfigCat source in Segment.
25-
8. **Integrate Feature Flag Evaluations:**
34+
- **Segment SDK:** Set up with the Segment Write Key acquired while adding the ConfigCat source in Segment.
35+
3. **Integrate Feature Flag Evaluations:**
2636
- During the initialization of the ConfigCat SDK, subscribe to the `flagEvaluated` hook.
2737
- Send feature flag evaluation data to Segment using the `featureFlagEvaluated` event name. Include the following parameter:
2838
- `featureFlagKey`: the feature flag's key
2939
- `value`: the evaluated feature flag's value or Variation ID
3040
- `variationId` (optional): the evaluated feature flag's Variation ID
3141
- `userId` (optional): the user object's identifier used during feature flag evaluation
3242
- `user` (optional): the user object used during feature flag evaluation.
33-
9. You can find code samples in the [ConfigCat Segment Source documentation](https://configcat.com/docs/integrations/segment?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”}.
43+
4. You can find code samples in the [ConfigCat Segment Source documentation](https://configcat.com/docs/integrations/segment#analytics?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”}.
3444

3545
## Stream
3646

3747
ConfigCat uses our stream Source component to send Segment event data. It uses a `track` method to send data to Segment. These events are then available in any destination that accepts events, and available in a schema in your data warehouse, so you can query using SQL.
3848

39-
The default behavior is for ConfigCat to pass the user object's identifier propery used during the feature flag evaluation as the userId.
49+
The default behavior is for ConfigCat to pass the user object's identifier property used during the feature flag evaluation as the userId or sending the ConfigCat User's ID who made the changes as the userId.
4050

4151
## Events
4252

43-
The table below lists events that <integration_name> sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. <integration_name> includes the `userId` if available.
53+
The table below lists events that ConfigCat sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. ConfigCat includes the `userId` if available.
4454

4555
| Event Name | Description |
4656
| ------------------ | ---------------------- |
4757
| featureFlagEvaluated | Feature flag evaluated |
58+
| featureFlagChanged | Feature flag changed |
4859

4960
## Event Properties
5061

5162
The table below list the properties included in the events listed above.
5263

64+
### `featureFlagEvaluated` event
65+
5366
| Property Name | Description |
5467
| ---------------- | ---------------------------------------------------------------- |
5568
| `featureFlagKey` | The feature flag's key |
5669
| `value` | The evaluated feature flag's value or Variation ID |
5770
| `variationId` | The evaluated feature flag's Variation ID |
5871
| `userId` | The user object's identifier used during feature flag evaluation |
5972
| `user` | The user object used during feature flag evaluation |
60-
73+
74+
### `featureFlagChanged` event
75+
76+
| Property Name | Description |
77+
| ----------------- | ---------------------------------------------------------------- |
78+
| `details` | A brief summary of the change |
79+
| `timestamp` | When the change happened |
80+
| `userId` | The ConfigCat user's ID who made the changes |
81+
| `userEmail` | The ConfigCat user's email who made the changes |
82+
| `userFullName` | The ConfigCat user's full name who made the changes |
83+
| `userId` | The ConfigCat user's ID Who made the changes |
84+
| `productId` | The product's ID where the change happened |
85+
| `productName` | The product's name where the change happened |
86+
| `configId` | The config's ID where the change happened |
87+
| `configName` | The config's name where the change happened |
88+
| `environmentId` | The environment's ID where the change happened |
89+
| `environmentName` | The environment's name where the change happened |
90+
| `url` | A direct link to the config/feature flag |
91+
| `userId` | The user object's identifier used during feature flag evaluation |
92+
| `user` | The user object used during feature flag evaluation |
6193

6294
## Adding Destinations
6395

0 commit comments

Comments
 (0)