Skip to content

Commit 4ce7583

Browse files
authored
Merge pull request #7454 from segmentio/DOC-1030
Event Tester [DOC-1030]
2 parents 3a5985f + f99ec0b commit 4ce7583

File tree

6 files changed

+70
-47
lines changed

6 files changed

+70
-47
lines changed

src/_data/sidenav/main.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ sections:
288288
- path: /connections/regional-segment
289289
title: Regional Segment
290290
- path: /connections/test-connections
291-
title: Event Tester
291+
title: Testing Connections
292292
- path: /connections/data-export-options
293293
title: Data Export Options
294294
- path: /connections/destination-data-control

src/connections/destinations/actions.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -157,14 +157,13 @@ To delete a destination action: click the action to select it, and click **Delet
157157
This takes effect within minutes, and removes the action completely. Any data that would have gone to the destination is not delivered. Once deleted, the saved action cannot be restored.
158158

159159
## Test a destination action
160-
To test a destination action, follow the instructions in [Testing Connections](/docs/connections/test-connections/). You must enable a mapping in order to test the destination. Otherwise, this error occurs: *You may not have any subscriptions that match this event.*
160+
To test a destination action, follow the instructions in [Event Tester](/docs/connections/test-connections/). You must enable a mapping in order to test the destination. Otherwise, this error occurs: *You may not have any subscriptions that match this event.*
161161

162162
You can also test within the mapping itself. To test the mapping:
163163
1. Navigate to the **Mappings** tab of your destination.
164164
2. Select a mapping and click the **...** and select **Edit Mapping**.
165-
3. In step 2 of the mappings edit page, click **Load Test Event from Source** to add a test event from the source, or you can add your own sample event.
166-
4. Scroll to step 4 on the page, and click **Test Mapping** to test the mapping and view the response from the destination.
167-
165+
3. In step 2 of the **Set up mappings** page, click **Load event from source** to add a test event from the source, select **Generate sample event** for Segment to generate a sample event for you, or enter your own event.
166+
4. Scroll to step 5 on the page and click **Send test event** to test the mapping and view the response from the destination.
168167

169168
> info "Test Mapping might not return the events you're looking for"
170169
> Segment only surfaces a small subset of events for the Test Mapping feature and might not always return the event you're looking for. If you'd like to test with a specific event, copy a specific event from your [Source Debugger](/docs/connections/sources/debugger/) and paste it into the **Add test event** interface.
347 KB
Loading
Loading

src/connections/test-connections.md

+54-35
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,79 @@
11
---
2-
title: "Event Tester"
2+
title: Testing Connections
33
---
44

5+
Segment provides these 2 testing tools to enable you to test your connections between Segment and your destination:
6+
* [Event Tester](#event-tester): Test all of your enabled mappings within a destination.
7+
* [Mappings Tester](#mappings-tester): Test a single mapping configuration for your destination.
58

6-
Segment has an Event Tester that enables you to test your connections between Segment and your destination. You can access the Event Tester from your Source Debugger, or from your destination settings.   
9+
Both testing tools share the same underlying testing infrastructure, which ensures consistent results across your testing workflows. The results from both testers display API requests, responses, and success/failure status to help you diagnose any issues.
710

8-
> info "Available for server-side event streaming destinations only"
9-
> This feature is only available for server-side integrations (also known as cloud-mode destinations). You can't use this for client-side integrations (also known as device-mode destinations).
11+
You can use the Event and Mappings Tester for these products:
12+
* [Connections](/docs/connections/)
13+
* [Linked Audiences](/docs/engage/audiences/linked-audiences/)
14+
* [Linked Events](/docs/unify/data-graph/linked-events/#testing-with-linked-events-enrichments)
15+
* [Reverse ETL](/docs/connections/reverse-etl/)
16+
* [Journeys](/docs/engage/journeys/)
1017

11-
## Use Cases
18+
## Event Tester
1219

13-
There are two scenarios where you might want to use the Event Tester:
20+
> info ""
21+
> The Event Tester is only available for server-side, [cloud-mode](/docs/connections/destinations/#connection-modes) integrations. It doesn't work for client-side, [device-mode](/docs/connections/destinations/#connection-modes) integrations.
22+
><br><br>You must have write access in your Segment workspace to use the Event Tester.
1423
15-
* ensuring an event is successfully making it to a specific destination
16-
* ensuring your new destination is configured correctly
24+
The Event Tester enables you to test your connections between Segment and your destination. You can inspect both the request sent from Segment and the response you receive back from the destination. The tester provides a comprehensive view of how your event data flows through multiple mappings. You can use the Event Tester to ensure:
1725

26+
* An event successfully arrives to a specific destination
27+
* Your new destination is configured correctly
1828

19-
## Ensuring an event is successfully making it to a specific destination
29+
The Event Tester sends a real event that appears in your end tool alongside your existing data.
2030

21-
**1. Choose an event from the Source Debugger that you want to debug and select "Validate"**
31+
### Using the Event Tester
2232

23-
Go to your Source Debugger, select an event and in the top right hand side of the debugger view, select "Validate".
33+
> info ""
34+
> The event tester only tests the enabled mappings for the destination.
2435
25-
![Screenshot of the Debugger tab, with a Checkout Started event selected and an error pointing to the Validate button.](images/event-tester_GgyOswJA.png)
36+
To use the Event Tester:
37+
1. Navigate to **Connections > Destinations** and select your destination.
38+
2. Click the **Event Tester** tab.
39+
3. Select the type of test event. You can choose from: Track, Identify, Page, Screen, Group.
40+
4. Enter your test event payload. You can type in your own event or choose from **Load event from source** or **Generate sample event**.
41+
* **Load event from source**: Segment loads an event based on your source.
42+
* **Generate sample event**: Segment generates a sample event for you.
43+
5. Click **Send test event to destination**.
44+
  
2645

27-
**2. Choose the destination you want to test with**
46+
If your test event successfully sends to the destination, you can see in the **View test outcome** section:
47+
* The request, response, and status for each API call
48+
* How many of your mappings matched
49+
* The total number of API calls that were made as one test event can result in multiple API calls
50+
* Which mappings were successful and which ones failed
51+
* The destination's API endpoint used to make the request
2852

29-
Select the destination that you want to test this event with. At this time, you can only use the Event Tester for cloud-mode (server side) destinations.
53+
![Screenshot of the Event Tester with a Track test event that resulted in 4 API calls](images/event-tester-2025.png)
3054

31-
![A screenshot of the destination selection pop up modal](images/event-tester_2JfoKddf.png)
55+
You can navigate between the different API calls and can use the filter to navigate to specific mappings.
3256

33-
**3. Send event to destination**
57+
![Screenshot of the Event Tester filter with dropdown of different mappings](images/event-tester-filter.png)
3458

35-
The event payload from your debugger that you just selected will automatically load in the JSON view. You have the option to edit the payload if you want. Assuming it looks good, select "Send Event" at the bottom right of the screen. 
59+
## Mappings Tester
60+
When you add a destination and create a mapping in Connections, Reverse ETL, Linked Audience, and Journeys, you can test the specific mapping using the Mappings Tester. The Mappings Tester only tests a single mapping at a time and you can edit field values before initiating a test. This helps you verify that your configured mapping works as expected.
3661

37-
![A screenshot of the Event Tester, with a track event selected](images/event-tester_J7TEDYvY.png)
62+
Use the Mappings Tester when you need to:
63+
* Verify a single mapping configuration
64+
* Edit field values before testing a mapping
65+
* Troubleshoot a specific mapping that isn't working as expected
3866

39-
**4. Ensure you're happy to send the test event to the destination**
67+
### Using the Mappings Tester
68+
To use the Mapppings Tester:
69+
1. Navigate to the product (Connections, Reverse ETL, Linked Audience, or Journeys) you want to test the mapping for.
70+
2. Select the destination that has the mapping you want to test.
71+
3. Select **Edit mapping**.
72+
4. Edit any values in the **Send test record** section.
73+
5. Click **Send test event**.
4074

41-
This is a real event that will appear in your end tool alongside your existing data. If you're not comfortable with this, then select "Cancel" and do not send the event. 
4275

43-
![Screenshot of the popup that appears when you click the Send test event button.](/docs/guides/images/asset_Yxw1DJqb.png)
44-
45-
**5. View the Partner API response**
46-
47-
On the right hand side of the Event Tester you will see the response from the partner API. At the top, Segment provide of summary of the response. Below is the raw response payload Segment received that you can use for further debugging if necessary. 
48-
49-
![A screenshot of the Event Tester with a successful response from the destination](images/event-tester_il6mvexS.png)
50-
51-
If you are receiving an error and are unsure how to fix the issue, visit the partner docs (for example [https://developers.google.com/analytics/devguides/reporting/core/v3/errors](https://developers.google.com/analytics/devguides/reporting/core/v3/errors){:target="_blank”}) or contact the partner support team. 
52-
53-
## FAQ
54-
55-
#### Why can't I see the Event Tester when I log into my workspace?
56-
57-
The Event Tester is only accessible to users with write access in their Segment workspace (read-only users will not see the Event Tester in their workspace). 
76+
## FAQs
5877

5978
#### The Event Tester experienced an error when sending my event. Why did this happen?
6079

src/unify/data-graph/linked-events.md

+12-7
Original file line numberDiff line numberDiff line change
@@ -180,18 +180,23 @@ In the Mappings tab, locate the **Select Mappings** section where you can enrich
180180

181181
1. Select the property field that you'd like to enrich, then select the **Enrichments** tab.
182182
2. Select the entity you want to send to your destination.
183-
- You’ll have access to all rows/columns in your data warehouse associated with the property you've selected in the previous step.
183+
- You have access to all rows/columns in your data warehouse associated with the property you've selected in the previous step.
184184
3. Add the key name on the right side, which is what Segment sends to your destination.
185+
4. Click **Save**.
185186

186-
> warning ""
187-
> At this time, Linked Events doesn't support a preview of enriched payloads.
187+
#### Testing with Linked Events Enrichments
188+
The [Event Tester and Mappings Tester](/docs/connections/test-connections/#) support testing enrichments from Linked Events, allowing you to verify that entity data is correctly attached to your events before they reach destinations. When you have Linked Events configured, these enrichments appear in your test payload, showing you exactly how profile traits will add to your events.
188189

189-
### Save your enrichments
190+
When you test mappings with Linked Events Enrichments:
191+
* You can view the enriched fields in the **Request** section of the test results.
192+
* Verify that the correct entity traits are attaching to your events based on your entity matching configuration.
193+
* The tester includes any configured Linked Events enrichments in the sample payload.
190194

191-
When you're satisfied with the mappings, click **Save**. Segment returns you to the Mappings table.
195+
This helps you confirm that the right information sends to your destinations when testing activation scenarios that rely on profile data enrichment
196+
197+
> info ""
198+
> If an enriched field appears empty in your test results, this could indicate either that the entity matching failed to find a matching profile, or that the profile exists but does not have data for that specific trait.
192199
193-
> warning ""
194-
> At this time, when you select mappings or test events, you won’t see enrichment data. Enrichment data is only available with real events.
195200

196201
## Enrichment observability
197202

0 commit comments

Comments
 (0)