Skip to content

Commit bd6834a

Browse files
Merge pull request #6485 from megancooper/events.win/destination
Add events.win destination docs
2 parents b077619 + 3fa957f commit bd6834a

File tree

1 file changed

+41
-0
lines changed
  • src/connections/destinations/catalog/events-win

1 file changed

+41
-0
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: events.win Destination
3+
beta: true
4+
id: 662d3328d029f89724a0c294
5+
---
6+
7+
[events.win](https://events.win/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="\_blank”} provides a single platform to create your tracking plan, sync event definitions to your code, and see detailed metrics on how correct your data is. With events.win, you can ensure that your tracking is accurate and up-to-date.
8+
9+
This destination is maintained by events.win. For any issues with the destination, [contact the events.win support team](mailto:[email protected]).
10+
11+
## Getting started
12+
13+
1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="\_blank”} search for "events.win".
14+
2. Select events.win and click **Add Destination**.
15+
3. Select an existing Source to connect to events.win.
16+
4. Go to the [events.win dashboard](https://app.events.win/developers){:target="\_blank"}, find and copy the **Developer key**.
17+
5. Return to Segment and enter the **Developer Key** in the events.win destination settings.
18+
6. events.win starts to receive data from Segment. There may be a delay before data is visible in the events.win dashboard.
19+
20+
## Supported methods
21+
22+
events.win supports Segment's [Track](/docs/connections/spec/track) method, as specified in the [Segment Spec](/docs/connections/spec).
23+
24+
### Track
25+
26+
events.win consumes and validates [Track](/docs/connections/spec/track) calls against the tracking plan you've previously defined in events.win. events.win doesn't store the data, but instead provides a detailed report on how correct your data is.
27+
28+
You can use the [@events.win/cli](https://www.npmjs.com/package/@events.win/cli){:target="\_blank”} to generate type-safe tracking code for your events.
29+
30+
```js
31+
/**
32+
* Example:
33+
* events.win will look at your spec for the event `login-button-clicked` and validate the properties `handle` and `id` are present and have the correct data type.
34+
*/
35+
analytics.track("login-button-clicked", {
36+
user: {
37+
handle: "frodo.baggins",
38+
id: "123456789",
39+
},
40+
});
41+
```

0 commit comments

Comments
 (0)