Skip to content

Commit

Permalink
Merge pull request #6933 from segmentio/dux-descriptive-link-text
Browse files Browse the repository at this point in the history
Replace generic link text with descriptive link text 🦆
  • Loading branch information
forstisabella authored Aug 13, 2024
2 parents 0583929 + 320705f commit fcc56d1
Show file tree
Hide file tree
Showing 112 changed files with 215 additions and 316 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Sources pages check if the source is a cloud-app, then include information about

## Edit pages

Content with in each `.md` file is markdown. For information about styling, and available extensions, see `_src/utils/formatguide.md` or the live version [here](https://segment.com/docs/utils/formatguide).
Content with in each `.md` file is markdown. For information about styling, and available extensions, see `_src/utils/formatguide.md` or the live version in the [utils section of the docs](/docs/utils/formatguide).

## Building a preview

Expand Down
2 changes: 1 addition & 1 deletion src/_includes/content/dev-center-note.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<div class="premonition info"><div class="fa fa-info-circle"></div><div class="content"><p class="header">Developer Center no longer accepts new components.</p><p markdown=1>Segment is redeveloping the Developer Center and will launch a new version when complete. To stay up to date, add your contact information [here](https://airtable.com/shrT3b4C7agUEBKVS){:target="_blank"}.</p></div></div>
<div class="premonition info"><div class="fa fa-info-circle"></div><div class="content"><p class="header">Developer Center no longer accepts new components.</p><p markdown=1>Segment is redeveloping the Developer Center and will launch a new version when complete. To stay up to date, add your contact information [in this Airtable form](https://airtable.com/shrT3b4C7agUEBKVS){:target="_blank"}.</p></div></div>
2 changes: 1 addition & 1 deletion src/_includes/content/ip-allowlist.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
When data leaves Segment's servers to go to various destinations (not including warehouses), Segment uses Amazon Web Services (AWS) and utilizes many different machines in order to send requests.

The IP addresses that are used to send these requests can be found [here](https://ip-ranges.amazonaws.com/ip-ranges.json){:target="_blank"}. If you want to allowlist these specific IP addresses, you need to allowlist all of the IP addresses from your workspace's location range. Below are the ranges:
The IP addresses that are used to send these requests can be found [on Amazon's website](https://ip-ranges.amazonaws.com/ip-ranges.json){:target="_blank"}. If you want to allowlist these specific IP addresses, you need to allowlist all of the IP addresses from your workspace's location range. Below are the ranges:
* For a US workspace: `AWS us-west-2`
* For an EU workspace: `AWS eu-west-1 `
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Then, in the Source, navigate to **Settings** > **API Keys**.
### API Key

To start working with Ambee as your destination, you'll need
Ambee's API Key. Sign up for Ambee [here](https://auth.ambeedata.com/users/register?redirectUrl=https://api-dashboard.getambee.com){:target="_blank"}.
Ambee's API Key. Sign up for Ambee [on the Ambee site](https://auth.ambeedata.com/users/register?redirectUrl=https://api-dashboard.getambee.com){:target="_blank"}.

Once you are signed in, you will get your limited-period API key on the
dashboard's homepage. If your use case requires data in bulk, you'll
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,13 +99,13 @@ analytics.ready(function() {
});
```
1. Set your GCM/FCM server API key and SenderID on the Braze dashboard. You can find more details for this [here](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup#step-4-set-your-gcmfcm-server-api-key-and-senderid-on-the-Braze-dashboard){:target="_blank"}.
1. Set your GCM/FCM server API key and SenderID on the Braze dashboard. You can find more details for this in Braze's [Initial SDK setup for web](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup#step-4-set-your-gcmfcm-server-api-key-and-senderid-on-the-Braze-dashboard){:target="_blank"} documentation.

2. To support push notifications on Safari, add your Website Push ID into your Segment Settings UI and Segment sends it when the Braze Web SDK initializes. To get your Website Push ID, follow the first two bullet points in [these instructions](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup#step-5-configure-safari-push){:target="_blank"}.

### Soft Push Prompts

1. Follow [step one](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup#soft-push-prompts){:target="_blank"} to create a "Prime for Push" in-app messaging Campaign on the Braze dashboard.
1. Follow [step one](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/soft_push_prompt/#step-1-create-a-push-primer-campaign){:target="_blank"} to create a "Prime for Push" in-app messaging Campaign on the Braze dashboard.

2. Add the following snippet to your site:

Expand Down Expand Up @@ -146,7 +146,7 @@ analytics.ready(function() {
});
```

For more details on this snippet, see Braze's documentation [here](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup#soft-push-prompts){:target="_blank"}.
For more details on this snippet, see Braze's [Soft push prompt](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/soft_push_prompt/#step-3-update-integration){:target="_blank"} documentation.
> info ""
> Place this snippet outside of your [Segment Snippet](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/#step-2-copy-the-segment-snippet) within your `script` tag.
Expand All @@ -160,7 +160,6 @@ For more details on this snippet, see Braze's documentation [here](https://www.b
```



## Important differences from the classic Braze destination
- Braze Web Mode (Actions) supports the Braze [Web](https://github.com/segment-integrations/analytics.js-integration-appboy){:target="_blank"} integration. [Braze Cloud Mode (Actions)](/docs/connections/destinations/catalog/actions-braze-cloud) supports server and mobile sources, but to use mobile sources in device-mode, use the Braze Classic destination.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ To configure DoubleClick Floodlight:
7. Click **Save** and make sure you enable the mapping.

> info ""
> The destination does not have configurable settings until you create an audience, described [here](#create-an-audience-and-finish-dv360-configuration).
> The destination does not have configurable settings until you create an audience, described in the [Create an audience and finish DV360 configuration](#create-an-audience-and-finish-dv360-configuration) documentation.
### Create an audience and finish DV360 configuration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Use this approach if you don't want to track users from the browser with Faceboo

### Send app events

App events may be sent through the Conversions API by first setting up a dataset in your Facebook Events Manager. Learn more about passing app events through the Conversions API [here](https://developers.facebook.com/docs/marketing-api/conversions-api/app-events){:target="_blank"}. Learn how to create a dataset [here](https://www.facebook.com/business/help/750785952855662?id=490360542427371){:target="_blank"}.
App events may be sent through the Conversions API by first setting up a dataset in your Facebook Events Manager. Learn more about passing app events through the Conversions API in Facebook's [Conversions API for App Events](https://developers.facebook.com/docs/marketing-api/conversions-api/app-events){:target="_blank"} documentation. Learn how to create a dataset in Facebook's [About datasets in Meta Events Manager](https://www.facebook.com/business/help/750785952855662?id=490360542427371){:target="_blank"} documentation.

#### Configuring app events
Sending app events requires the `action_source` parameter to be set to `app`.
Expand Down Expand Up @@ -209,7 +209,7 @@ Segment automatically maps User Data fields to their corresponding parameters [a

### Server Event Parameter Requirements

Facebook requires the `action_source` server event parameter for all events sent to the Facebook Conversions API. This parameter specifies where the conversions occur. If `action_source` is set to **website**, then the `client_user_agent` and the `event_source_url` parameters are also required. Events sent to the Conversions API that don't meet the requirements may not be available for optimization, targeting, or measurement. Facebook requires additional fields as well such as, Event Name, Event Type, and User Data. See the full list of required fields [here](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event/).
Facebook requires the `action_source` server event parameter for all events sent to the Facebook Conversions API. This parameter specifies where the conversions occur. If `action_source` is set to **website**, then the `client_user_agent` and the `event_source_url` parameters are also required. Events sent to the Conversions API that don't meet the requirements may not be available for optimization, targeting, or measurement. Facebook requires additional fields as well such as, Event Name, Event Type, and User Data. See the full list of required fields in Facebook's [Server Event Parameters](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event/){:target="_blank”} documentation.

### Verify Events in Facebook

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Event payloads should contain an email with either a valid format, empty string,
Follow the instructions in the docs to [disable](/docs/connections/destinations/actions/#disable-a-destination-action) or [delete](/docs/connections/destinations/actions/#delete-a-destination-action) a destination action from Segment.

### How can I uninstall an app from my HubSpot account?
Follow the steps mentioned [here](https://knowledge.hubspot.com/integrations/connect-apps-to-hubspot#uninstall-an-app){:target="_blank"} to uninstall or disconnect an app from your HubSpot account.
Follow the steps outlined in HubSpot's [Uninstall an app](https://knowledge.hubspot.com/integrations/connect-apps-to-hubspot#uninstall-an-app){:target="_blank"} docs to uninstall or disconnect an app from your HubSpot account.

### How does disconnecting and uninstalling affect a user's data and HubSpot account?
Segment immediately stops sending data to HubSpot after you disconnect and uninstall a HubSpot account.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ To send data to a Salesforce Pardot sandbox instance, navigate to **Settings** a
Your sandbox username appends the sandbox name to your Salesforce production username. For example, if a username for a production org is `[email protected]` and the sandbox is named `test`, the username to log in to the sandbox is `[email protected]`.

> info ""
> Data and configuration can’t be shared between sandbox and production accounts. Make sure you use the Pardot Business Unit ID corresponding to your sandbox account. Information on how to create a sandbox for Pardot can be found [here](https://help.salesforce.com/s/articleView?language=en_US&type=5&id=sf.pardot_sf_connector_sandbox.htm){:target="_blank"}.
> Data and configuration can’t be shared between sandbox and production accounts. Make sure you use the Pardot Business Unit ID corresponding to your sandbox account. Information on how to create a sandbox for Pardot can be found in the Salesforce [Create a Sandbox for Account Engagement](https://help.salesforce.com/s/articleView?language=en_US&type=5&id=sf.pardot_sf_connector_sandbox.htm){:target="_blank"} documentation.
### How do I add custom prospect fields?
Custom fields can be included in the Other Fields mapping. Custom fields must be predefined in your Pardot account and should end with `__c` (for example, `custom_field__c`). Please include the `__c` in your mapping.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ To connect the Pinterest Conversions API Destination:
- Destination Name
- [Ad Account ID](https://developers.pinterest.com/docs/conversions/conversions/#Find%20your%20%2Cad_account_id#Find%20your%20%2Cad_account_id#Find%20your%20%2Cad_account_id){:target="_blank”}
- [Conversions Token](https://developers.pinterest.com/docs/conversions/conversions/#Get%20the%20conversion%20token){:target="_blank”}
6. Navigate to the **Mappings** tab, there are already Prebuilt mapping like `Checkout,Search,Add to Cart` defined with prescribed parameter . All required ,recommended and optional fields are listed [here](https://developers.pinterest.com/docs/conversions/best/#Authenticating%20for%20the%20Conversion%20Tracking%20endpoint#The%20%2Cuser_data%2C%20and%20%2Ccustom_data%2C%20objects#Required%2C%20recommended%2C%20and%20optional%20fields#Required%2C%20recommended%2C%20and%20optional%20fields){:target="_blank”}
6. Navigate to the **Mappings** tab, there are already Prebuilt mapping like `Checkout`, `Search`, `Add to Cart` defined with prescribed parameters. All required, recommended, and optional fields are listed in Pinterest's [Best practices](https://developers.pinterest.com/docs/api-features/conversion-best-practices/#required-recommended-and-optional-fields){:target="_blank”} documentation.
7. If you want to create **New Mapping**, and select **Report Conversions Event** ,configure and enable it.
8. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
9. Enable the destination using the **Enable Destination** toggle switch and click **Save Changes**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To link your Qualtrics destination in Segment to your Qualtrics workspace, [Qual
2. Find the Destinations Actions item in the left navigation, and click it.
3. Click **Configure Qualtrics**.
4. Select an existing Source to connect to Qualtrics (Actions).
5. To authenticate, enter your API key & Datacenter ID. To locate your API key & Datacenter ID, follow in the instructions found [here](https://api.qualtrics.com/ZG9jOjg3NjYzNQ-finding-your-qualtrics-i-ds){:target="_blank”}.
5. To authenticate, enter your API key & Datacenter ID. To locate your API key & Datacenter ID, follow in the instructions in the [Finding your Qualtrics IDs](https://api.qualtrics.com/ZG9jOjg3NjYzNQ-finding-your-qualtrics-i-ds){:target="_blank”} documentation.

<!-- The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions. -->

Expand Down
10 changes: 4 additions & 6 deletions src/connections/destinations/catalog/adikteev/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,14 @@ This destination is maintained by Adikteev. For any issues with the destination,

## Getting Started

This destination only supports events from Mobile sources.


Currently, this destination supports events originating from Mobile sources alone.

You can read more about how to define a source [here](/docs/connections/sources/#what-is-a-source).
You can read more about how to define a source in Segment's [Source Overview](/docs/connections/sources/#what-is-a-source) docs.

To get started with Adikteev and Segment, you'll need an account with Adikteev.

If you don't have an account with Adikteev and want to use our services together with Segment contact us here: [[email protected]](mailto:[email protected]).
If you don't have an account with Adikteev, contact them at [[email protected]](mailto:[email protected]).

## Track

Adikteev is built to understand and analyze all the events generated by your app. For us to receive and analyze the events correctly, make sure you use the right [Track](/docs/connections/spec/track/) events as specified by Segment's Spec.
Adikteev accepts [Track](/docs/connections/spec/track/) events as specified by the Segment Spec.
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ analytics.page({

## Custom Traffic Variables - props

Custom Traffic Variables, also known as props, allow you to correlate custom data with specific traffic-related events in Adobe. To learn more about props and how to configure them in the Adobe UI, see the documentation [here](https://docs.adobe.com/content/help/en/analytics/admin/admin-tools/traffic-variables/traffic-var.html){:target="_blank”}. You can map your Segment properties in your destination settings to any of your Adobe props.
Custom Traffic Variables, also known as props, allow you to correlate custom data with specific traffic-related events in Adobe. To learn more about props and how to configure them in the Adobe UI, see the documentation on [Traffic variables (props) overview](https://docs.adobe.com/content/help/en/analytics/admin/admin-tools/traffic-variables/traffic-var.html){:target="_blank”}. You can map your Segment properties in your destination settings to any of your Adobe props.

![A screenshot of the Adobe Analytics settings page in Segment, with the Mappings section selected and a sample property mapping under the Props tab.](images/prop-mapping.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ Segment's S3 destination contains a copy of all of the source data you configure

Note that this step is not required unless you plan to do batch data extraction from S3.

Your Glue ETL job will need to crawl each source folder to extract the backup data that forms your training set. Analysis of this data set is beyond the scope of this document. It is strongly recommended you familiarize yourself with the types of events that can be sent through Segment. Segment's event structure is described in detail [here](/docs/connections/sources/catalog/libraries/server/http/).
Your Glue ETL job will need to crawl each source folder to extract the backup data that forms your training set. Analysis of this data set is beyond the scope of this document. It is strongly recommended you familiarize yourself with the types of events that can be sent through Segment. Segment's event structure is described in detail on Segment's [HTTP source](/docs/connections/sources/catalog/libraries/server/http/) documentation.

The following examples show how to configure an AWS Glue job to convert Segment historical data into the Apache Avro format that Personalize wants to consume for training data sets.

Expand Down Expand Up @@ -596,7 +596,7 @@ Once Segment's event CSV is finished importing into a user-item interaction data
![A screenshot of the Dataset groups dashboard, with a box around the Start button in the Create solutions column.](images/PersonalizeCreateSolution.png)
2. On the **Create solution** page, enter a **Solution name**.
* For a discussion on the different recipes you can use with Personalize, see [here](https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html){:target="_blank"}.
* For a discussion on the different recipes you can use with Personalize, see Amazon's [Choosing a recipe](https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html){:target="_blank"} documentation.
![A screenshot of the Create solution page, with a solution name entered in the Solution name field.](images/PersonalizeSolutionConfig.png)
Expand Down
2 changes: 1 addition & 1 deletion src/connections/destinations/catalog/appsflyer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ Segment uses AppsFlyer's `transactionId` deduplication when you send an `orderId
## Install Attributed

### Client
Segment will automatically trigger an `Install Attributed` event if you have **trackAttributionData** enabled in your settings, and the Segment-AppsFlyer integration installed in your app. The event payload will adhere to the `Install Attributed` event specification documented [here](/docs/connections/spec/mobile/#install-attributed) and will propagate to your other downstream destinations.
Segment will automatically trigger an `Install Attributed` event if you have **trackAttributionData** enabled in your settings, and the Segment-AppsFlyer integration installed in your app. The event payload will adhere to the `Install Attributed` event specification explained in Segment's [Mobile Spec](/docs/connections/spec/mobile/#install-attributed) and will propagate to your other downstream destinations.

### Server
If you track events server-side, AppsFlyer can still send attribution postbacks, but you need to configure this functionality in your AppsFlyer account. To enable this:
Expand Down
Loading

0 comments on commit fcc56d1

Please sign in to comment.