diff --git a/src/connections/destinations/actions.md b/src/connections/destinations/actions.md index 6681fb62b6..1497d0df8c 100644 --- a/src/connections/destinations/actions.md +++ b/src/connections/destinations/actions.md @@ -185,7 +185,6 @@ If necessary, click **New Mapping** to create a new, blank action. 6. When you're satisfied with the mapping, click **Save**. Segment returns you to the Mappings table. 7. In the Mappings table **Status** column, verify that the **Enabled** toggle is on for the mapping you just customized. - > info "" > The required fields for a destination mapping appear automatically. Click the + sign to see optional fields. diff --git a/src/connections/destinations/index.md b/src/connections/destinations/index.md index 1ecd024464..17d6a1fede 100644 --- a/src/connections/destinations/index.md +++ b/src/connections/destinations/index.md @@ -107,6 +107,18 @@ The first place to look is the individual destination documentation. Each one in In order to override the default, check the destination settings pane in the Segment web App either for a **Connection Mode** toggle or instructions on bundling any additional mobile components required. +## Sync modes + +Sync mode allows users to define how changes in the source should send downstream to your destination. Depending on which destinations you set up in Segment, you may need to choose a sync mode for your data. This configuration determines how Segment updates your destination based on the source data. + +The available sync modes can vary based on the destination, integration type, and actions within the destination. For example, if you sync customer data, you might have the option to Insert, Update, or Upsert records. + +Available sync modes include: +- **Update**: Modify existing records in the destination without adding new ones. +- **Upsert**: Update existing records and add new ones, if necessary. +- **Add**: Add records to a list, segment, or journey. +- **Remove**: Remove records from a list, audience, or journey. + ## Add a destination To add a Destination: diff --git a/src/connections/reverse-etl/setup.md b/src/connections/reverse-etl/setup.md index edd65caaf7..95dd35ac3c 100644 --- a/src/connections/reverse-etl/setup.md +++ b/src/connections/reverse-etl/setup.md @@ -77,25 +77,25 @@ To create a mapping: 2. Select the destination that you want to create a mapping for. 3. Click **Add Mapping**. 4. Select the model to sync from. -5. Select the **Action** you want to sync and click **Next**. - * Actions determine the information sent to the destination. The list of Actions will be unique to each destination. -6. Add a name for your mapping. The mapping name defaults to the Action's name (for example, 'Track Event'), but can be customized to allow you to identify the mapping across others. -7. In the **Select record to map and send** section, select which records to send to your destination after Segment completes extracting data based on your model. You can choose from: - * Added records - * Updated records - * Added or updated records - * Deleted records -8. Select a test record to preview the fields that you can map to your destination in the **Add test record** field. -9. Select how often you want Segment to sync your data under **Schedule configuration**. +5. In the **Define sync behavior** section, select the **Action** you want to sync. + * Actions determine the information sent to the destination. The list of Actions are unique to each destination. +6. Select which records to send to your destination after Segment completes extracting data based on your model. + * Some destinations have [sync modes](/docs/connections/destinations/#sync-modes), which let you specify how Segment should send data to the destination. Sync modes are unique to each destination. + * Destinations without sync modes let you select from the following options: + * Added records + * Updated records + * Added or updated records + * Deleted records +7. In the **Map fields** section, define how to map the record columns from your model to your destination. Map the fields that come from your source to fields that the destination expects to find. Fields on the destination side depend on the type of Action selected. + * If you’re setting up a Destination Action, some mapping fields might require data to be in the form of an object or array. See the [supported objects and arrays for mapping](/docs/connections/reverse-etl/manage-retl/#supported-object-and-arrays) for more information. + +8. In the **Send test record section**, select a test record to preview the fields that you mapped to your destination. When you've verified that the records appear as expected, click **Next**. +9. Enter a name for your mapping. The name initially defaults to the Action's name, for example, `Track Event`, but you can make changes to this default name. +10. Select how often you want Segment to sync your data under **Schedule configuration**. * **Interval**: Extractions perform based on a selected time cycle. Select one of the following options: 15 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, 6 hours, 8 hours, 12 hours, 1 day. * **Day and time**: Extractions perform at specific times on selected days of the week. -10. Define how to map the record columns from your model to your destination in the **Select Mappings** section. - * You map the fields that come from your source to fields that the destination expects to find. Fields on the destination side depend on the type of action selected. - * If you're setting up a destination action, depending on the destination, some mapping fields may require data to be in the form of an object or array. See the [supported objects and arrays for mapping](/docs/connections/reverse-etl/manage-retl/#supported-object-and-arrays). -11. *(Optional)* Send a test record to verify the mappings correctly send to your destination. -12. Click **Create Mapping**. -13. Select the destination you’d like to enable on the **My Destinations** page under **Reverse ETL > Destinations**. -14. Turn the toggle on for the **Mapping Status**. Events that match the trigger condition in the mapping will be sent to the destination. +11. Select the destination you’d like to enable on the **My Destinations** page under **Reverse ETL > Destinations**. +12. Turn the toggle on for the **Mapping Status**. Events that match the trigger condition in the mapping will be sent to the destination. * If you disable the mapping state to the destination, events that match the trigger condition in the mapping won’t be sent to the destination. ## Initial sync for a given mapping