|
1 | 1 | ---
|
2 |
| -title: "Event Tester" |
| 2 | +title: Testing Connections |
3 | 3 | ---
|
4 | 4 |
|
| 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. |
5 | 8 |
|
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. |
7 | 10 |
|
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/) |
10 | 17 |
|
11 |
| -## Use Cases |
| 18 | +## Event Tester |
12 | 19 |
|
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. |
14 | 23 |
|
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: |
17 | 25 |
|
| 26 | +* An event successfully arrives to a specific destination |
| 27 | +* Your new destination is configured correctly |
18 | 28 |
|
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. |
20 | 30 |
|
21 |
| -**1. Choose an event from the Source Debugger that you want to debug and select "Validate"** |
| 31 | +### Using the Event Tester |
22 | 32 |
|
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. |
24 | 35 |
|
25 |
| - |
| 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 | + |
26 | 45 |
|
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 |
28 | 52 |
|
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 | + |
30 | 54 |
|
31 |
| - |
| 55 | +You can navigate between the different API calls and can use the filter to navigate to specific mappings. |
32 | 56 |
|
33 |
| -**3. Send event to destination** |
| 57 | + |
34 | 58 |
|
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. |
36 | 61 |
|
37 |
| - |
| 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 |
38 | 66 |
|
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**. |
40 | 74 |
|
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. |
42 | 75 |
|
43 |
| - |
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 |
| - |
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 |
58 | 77 |
|
59 | 78 | #### The Event Tester experienced an error when sending my event. Why did this happen?
|
60 | 79 |
|
|
0 commit comments