Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

master into develop after one-offs #7473

Merged
merged 18 commits into from
Mar 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/_data/sidenav/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ sections:
- path: /connections/regional-segment
title: Regional Segment
- path: /connections/test-connections
title: Event Tester
title: Testing Connections
- path: /connections/data-export-options
title: Data Export Options
- path: /connections/destination-data-control
Expand Down
7 changes: 3 additions & 4 deletions src/connections/destinations/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,14 +157,13 @@ To delete a destination action: click the action to select it, and click **Delet
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.

## Test a destination action
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.*
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.*

You can also test within the mapping itself. To test the mapping:
1. Navigate to the **Mappings** tab of your destination.
2. Select a mapping and click the **...** and select **Edit Mapping**.
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.
4. Scroll to step 4 on the page, and click **Test Mapping** to test the mapping and view the response from the destination.

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.
4. Scroll to step 5 on the page and click **Send test event** to test the mapping and view the response from the destination.

> info "Test Mapping might not return the events you're looking for"
> 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.
Expand Down
Binary file added src/connections/images/event-tester-2025.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
89 changes: 54 additions & 35 deletions src/connections/test-connections.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,79 @@
---
title: "Event Tester"
title: Testing Connections
---

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

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.   
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.

> info "Available for server-side event streaming destinations only"
> 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).
You can use the Event and Mappings Tester for these products:
* [Connections](/docs/connections/)
* [Linked Audiences](/docs/engage/audiences/linked-audiences/)
* [Linked Events](/docs/unify/data-graph/linked-events/#testing-with-linked-events-enrichments)
* [Reverse ETL](/docs/connections/reverse-etl/)
* [Journeys](/docs/engage/journeys/)

## Use Cases
## Event Tester

There are two scenarios where you might want to use the Event Tester:
> info ""
> 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.
><br><br>You must have write access in your Segment workspace to use the Event Tester.

* ensuring an event is successfully making it to a specific destination
* ensuring your new destination is configured correctly
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:

* An event successfully arrives to a specific destination
* Your new destination is configured correctly

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

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

Go to your Source Debugger, select an event and in the top right hand side of the debugger view, select "Validate".
> info ""
> The event tester only tests the enabled mappings for the destination.

![Screenshot of the Debugger tab, with a Checkout Started event selected and an error pointing to the Validate button.](images/event-tester_GgyOswJA.png)
To use the Event Tester:
1. Navigate to **Connections > Destinations** and select your destination.
2. Click the **Event Tester** tab.
3. Select the type of test event. You can choose from: Track, Identify, Page, Screen, Group.
4. Enter your test event payload. You can type in your own event or choose from **Load event from source** or **Generate sample event**.
* **Load event from source**: Segment loads an event based on your source.
* **Generate sample event**: Segment generates a sample event for you.
5. Click **Send test event to destination**.


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

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.
![Screenshot of the Event Tester with a Track test event that resulted in 4 API calls](images/event-tester-2025.png)

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

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

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. 
## Mappings Tester
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.

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

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

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. 

![Screenshot of the popup that appears when you click the Send test event button.](/docs/guides/images/asset_Yxw1DJqb.png)

**5. View the Partner API response**

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. 

![A screenshot of the Event Tester with a successful response from the destination](images/event-tester_il6mvexS.png)

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. 

## FAQ

#### Why can't I see the Event Tester when I log into my workspace?

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). 
## FAQs

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

Expand Down
34 changes: 33 additions & 1 deletion src/engage/journeys/event-triggered-journeys-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,38 @@ Segment creates these aliases automatically during setup, and they show up in th

Deleting a Hold Until step can impact downstream steps that rely on it. When you delete a configured step, Segment displays a modal that summarizes the potential impact on related branches and steps. Review all dependencies carefully to avoid unintentionally disrupting the journey.

## Fixed delays

The **Delay** step helps you control the timing of journey actions by pausing profiles for a set period before they continue in the journey. This enables controlled timing for messages, actions, or other journey events.

Unlike the Hold Until step, Delay doesn't depend on a user action: profiles always move down the journey after the time you set. This makes Delay useful for pacing interactions, like spacing out emails, without requiring user engagement.

### How Delay works

When a journey reaches the Delay step:

1. Profiles enter the step and wait for the configured duration.
2. Segment logs the profile's status in the observability timeline.
3. If the profile meets an exit condition during the hold period, the profile leaves the journey early.
4. After the delay ends, the profile moves to the next step in the journey.

### Configurable parameters

The following table explains the parameters you can configure for the Delay step:

| Parameter | Details |
| ------------------ | ------------------------------------------------------- |
| Duration time unit | Set the delay period in minutes, hours, days, or weeks. |
| Minimum delay | 5 minutes |
| Maximum delay | 182 days (around 6 months) |

To configure the Delay step:

1. Drag the Delay step onto the journey canvas, or click **+** to add it.
2. (*Optional*) Give the step a unique name.
3. Enter a duration and select a time unit (minutes, hours, days, weeks).
4. Click **Save**.

## Send to Destination

The **Send to Destination** step lets you send journey data to one of your [configured Engage destinations](/docs/connections/destinations/), enabling real-time integration with tools like marketing platforms, analytics systems, or custom endpoints.
Expand Down Expand Up @@ -218,4 +250,4 @@ There may be cases where events sent to Segment are missing specific properties
- If an event property is mapped but is missing in the Track event, Segment still includes the mapped key in the payload but with a value of `undefined`.
- Similarly, if a mapped trait is missing on the profile, the key is included in the payload with a value of `undefined`.

Carefully configuring mappings and handling missing attributes can help you maintain data integrity and avoid errors in downstream systems.
Carefully configuring mappings and handling missing attributes can help you maintain data integrity and avoid errors in downstream systems.
19 changes: 12 additions & 7 deletions src/unify/data-graph/linked-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,18 +180,23 @@ In the Mappings tab, locate the **Select Mappings** section where you can enrich

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

> warning ""
> At this time, Linked Events doesn't support a preview of enriched payloads.
#### Testing with Linked Events Enrichments
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.

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

When you're satisfied with the mappings, click **Save**. Segment returns you to the Mappings table.
This helps you confirm that the right information sends to your destinations when testing activation scenarios that rely on profile data enrichment

> info ""
> 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.

> warning ""
> At this time, when you select mappings or test events, you won’t see enrichment data. Enrichment data is only available with real events.

## Enrichment observability

Expand Down
Loading