diff --git a/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md b/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md index 731f93fa44..1ca8e2418a 100644 --- a/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md +++ b/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md @@ -80,7 +80,7 @@ With the Facebook Conversions API (Actions) destination, you can choose any fiel ![the coalesce function](images/image1.png) -You can send additional User Data to increase the match rate for events from a server source. Collect other fields from the browser, like User Agent, IP Address, and [Facebook's cookie parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc){:target="_blank"}, pass them to the server, and map them in the User Data object. See [Facebook's Customer Information Parameters](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters){:target="_blank"} for more information on User Data fields, and [Facebook's Best Practices for Conversions API](https://www.facebook.com/business/help/308855623839366?id=818859032317965){:target="_blank"} for match rate best practices. +You can send additional User Data to increase the match rate for events from a server source. Collect other fields from the browser, like User Agent, IP Address, and [Facebook's cookie parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc){:target="_blank"}, pass them to the server, and map them in the User Data object. See [Facebook's Customer Information Parameters](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters){:target="_blank"} for more information on User Data fields, and [Facebook's Best Practices for Conversions API](https://www.facebook.com/business/help/308855623839366?id=818859032317965){:target="_blank"} for match rate best practices. In addition, you can check your [event match quality (EMQ) rating](https://www.facebook.com/business/help/765081237991954?id=818859032317965){:target="_blank"} in the Meta Events Manager. ![the user data object](images/image2.png) @@ -104,7 +104,7 @@ With the Facebook Conversions API (Actions) destination, you can choose any fiel ![the coalesce function](images/image1.png) -You can send additional User Data to increase the match rate for events from a server source. Collect other fields from the browser, like User Agent, IP Address, and [Facebook's cookie parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc){:target="_blank"}, pass them to the server, and map them in the User Data object. See [Facebook's Customer Information Parameters](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters){:target="_blank"} for more information on User Data fields, and [Facebook's Best Practices for Conversions API](https://www.facebook.com/business/help/308855623839366?id=818859032317965){:target="_blank"} for match rate best practices. +You can send additional User Data to increase the match rate for events from a server source. Collect other fields from the browser, like User Agent, IP Address, and [Facebook's cookie parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc){:target="_blank"}, pass them to the server, and map them in the User Data object. See [Facebook's Customer Information Parameters](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters){:target="_blank"} for more information on User Data fields, and [Facebook's Best Practices for Conversions API](https://www.facebook.com/business/help/308855623839366?id=818859032317965){:target="_blank"} for match rate best practices. In addition, you can check your [event match quality (EMQ) rating](https://www.facebook.com/business/help/765081237991954?id=818859032317965){:target="_blank"} in the Meta Events Manager. ![the user data object](images/image2.png) @@ -120,7 +120,7 @@ Use this approach if you don't want to track users from the browser with Faceboo If you use Facebook Conversions API as a stand-alone without certain data fields collected from the browser, the match rate might not be as high as if you included them. You can increase the match rate for events from a server source by including User Data, such as Zip Code, Country and State. -You can send additional User Data to increase the match rate for events from a server source. Collect other fields from the browser, like User Agent, IP Address, and [Facebook's cookie parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc){:target="_blank"}, pass them to the server, and map them in the User Data object. +You can send additional User Data to increase the match rate for events from a server source. Collect other fields from the browser, like User Agent, IP Address, and [Facebook's cookie parameters (fbp, fbc)](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc){:target="_blank"}, pass them to the server, and map them in the User Data object. In addition, you can check your [event match quality (EMQ) rating](https://www.facebook.com/business/help/765081237991954?id=818859032317965){:target="_blank"} in the Meta Events Manager. #### Deduplication considerations diff --git a/src/connections/destinations/catalog/actions-pardot/images/image1.png b/src/connections/destinations/catalog/actions-pardot/images/image1.png new file mode 100644 index 0000000000..82ac0ebff2 Binary files /dev/null and b/src/connections/destinations/catalog/actions-pardot/images/image1.png differ diff --git a/src/connections/destinations/catalog/actions-pardot/images/image2.png b/src/connections/destinations/catalog/actions-pardot/images/image2.png new file mode 100644 index 0000000000..e76403cf79 Binary files /dev/null and b/src/connections/destinations/catalog/actions-pardot/images/image2.png differ diff --git a/src/connections/destinations/catalog/actions-pardot/index.md b/src/connections/destinations/catalog/actions-pardot/index.md new file mode 100644 index 0000000000..c3ba0a61af --- /dev/null +++ b/src/connections/destinations/catalog/actions-pardot/index.md @@ -0,0 +1,70 @@ +--- +title: Pardot (Actions) Destination +hide-boilerplate: true +hide-dossier: true +hidden: true +strat: salesforce +id: 62df16e45ba0058c864a75d1 +--- +Pardot is a Salesforce marketing automation and analytics solution that lets you send automated emails to prospects and track conversions in emails and across social networks. + +Segment’s Pardot (Actions) destination enables you to create and update prospects with custom traits that can be leveraged in your marketing efforts. Segment sends data to [version 5 of the Pardot API](https://developer.salesforce.com/docs/marketing/pardot/guide/version5overview.html){:target="_blank"}. + +> success "Good to know" +> This page is about the [Actions-framework](/docs/connections/destinations/actions/) Pardot destination. There's also a page about the [non-Actions Pardot destination](/docs/connections/destinations/catalog/pardot/). Both of these destinations receive data from Segment. + +## Benefits of Pardot (Actions) Destination vs Pardot Destination Classic + +The Pardot (Actions) destination provides the following benefits over the classic Pardot destination: +- **Fewer settings**. Data mapping for actions-based destinations happens during configuration, which eliminates the need for most settings. +- **Clearer mapping of data**. Actions-based destinations enable you to define the mapping between the data Segment receives from your source, and the data Segment sends to Pardot. +- **Sandbox support**. Testing with a Salesforce Pardot sandbox account before implementing in your production account enables you to feel confident in your configuration. +- **API upgrade**. Data is sent to version 5 of the Pardot API — the newest and most standardized version of the API. +- **Transparent error handling**. Triage and resolve any errors blocking delivery to Pardot with clearer error messages and steps to fix. +- **OAuth 2.0 support**. Authentication with Salesforce Pardot leverages OAuth 2.0 with an improved token refresh flow. + +## Getting started + +To get started using Pardot with Segment: +1. Make sure you have a Salesforce account with Pardot REST API access. +2. Navigate to `https://app.segment.com/[workspace-slug]/destinations/catalog/actions-pardot`. Replace `[workspace-slug]` with your workspace slug. +3. Click **Configure Pardot (Actions)** in the top-right corner of the screen. +4. Accept the Beta terms. +5. Select the source that will send data to Pardot (Actions) and follow the steps to name your destination. +6. On the **Settings** tab, authenticate with Salesforce Pardot using OAuth. Input the Pardot Business Unit ID associated with your Pardot Account, and click **Save**. +7. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customizing-mappings). +8. Enable the destination and configured mappings. + + + +## FAQ +### When will Pardot create versus update a prospect? +In version 5 of the Pardot API, the email address is used to upsert a prospect. +- If there’s no prospect with the email address provided, a prospect is created. +- If there’s one prospect with the email address provided, that prospect is updated. +- If multiple prospects have the same email address provided, the prospect with the latest activity is updated. +Please note that Pardot treats email address as case sensitive and will create multiple prospects for casing differences. + +### How do I enable a sandbox instance? +To send data to a Salesforce Pardot sandbox instance, navigate to **Settings** and toggle on the “Sandbox Instance” setting. If you have not set up OAuth yet, connect with your sandbox username. If you are already authenticated, please disconnect and reconnect with your sandbox username. Update your Pardot Business Unit ID with the ID corresponding to your sandbox account and click **Save**. + +Your sandbox username appends the sandbox name to your Salesforce production username. For example, if a username for a production org is `user@acme.com` and the sandbox is named `test`, the username to log in to the sandbox is `user@acme.com.test`. + +> 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"}. + +### 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. + +You can see and add custom prospect fields in Pardot under **Pardot Settings** > **Object and Field Configuration** > **Prospect Fields**. Be sure to input the **FIELD API NAME** exactly as it appears in Pardot in your Segment mapping. + +![the custom fields](images/image1.png) + +### How do I update a prospect’s email address? +With version 5 of the Pardot API, you can update a prospect’s email address using the Other Fields mapping. To update a prospect's email address: +1. Input the prospect’s current email in the Email Address mapping. This will be used to search for the corresponding prospect in Pardot. +2. Input the prospect’s new email in the **Other Fields** mapping with a field name of “email”. + +In the example below, `origin@example.org` is the prospect’s current email. `update@example.org` is the prospect’s new email that will be updated in Pardot. + +![the email update](images/image2.png) diff --git a/src/connections/destinations/catalog/google-analytics/index.md b/src/connections/destinations/catalog/google-analytics/index.md index 06582e089a..9acb8ef017 100644 --- a/src/connections/destinations/catalog/google-analytics/index.md +++ b/src/connections/destinations/catalog/google-analytics/index.md @@ -625,7 +625,7 @@ Analytics.track( If you want to send UTM parameters to Google Universal Analytics using one of the Segment server-side sources they need to be passed manually. The client-side Javascript library ([Analytics.js](/docs/connections/sources/catalog/libraries/website/javascript)) is highly recommended for collecting this data since it all happens automatically. -Your UTM params need to be passed in the `context` object in `context.campaign`. For Google Universal Analytics `campaign.name`, `campaign.source` and `campaign.medium` all need to be sent together for things to show up in reports. The other two params (`campaign.term` and `campaign.content`) are both optional, but will be forwarded to GA if you send them to Segment. +Your UTM params need to be passed in the `context` object in `context.campaign`. For Google Universal Analytics `campaign.name`, `campaign.source` and `campaign.medium` all need to be sent together for things to show up in reports. The `campaign.content` param is optional, but will be forwarded to GA if you send it to Segment. ### Measurement Protocol Parameters diff --git a/src/connections/destinations/catalog/hubspot/index.md b/src/connections/destinations/catalog/hubspot/index.md index c684d60f94..054fd93e18 100644 --- a/src/connections/destinations/catalog/hubspot/index.md +++ b/src/connections/destinations/catalog/hubspot/index.md @@ -7,17 +7,19 @@ id: 54521fd725e721e32a72eec1 --- [HubSpot](https://www.hubspot.com/) is an inbound marketing and sales platform that helps companies attract visitors, convert leads, and close customers. The `analytics.js` HubSpot Destination is open-source. You can browse the code [on GitHub](https://github.com/segmentio/analytics.js-integrations/tree/master/integrations/hubspot). +> info "" +> As of July 2022, HubSpot no longer allows new connections to authenticate with an API Key. Existing API Keys will continue to work, but to authenticate a new API connection with HubSpot, use a Private App Token. To generate a Private App access token from the HubSpot dashboard, navigate to **Integrations > Private Apps**. Segment requires the following scopes: `business-intelligence`, `crm.objects.contacts.read`, `crm.objects.contacts.write`, `crm.schemas.contacts.read`, `crm.objects.companies.read`, `crm.objects.companies.write`, `crm.schemas.companies.read`. For more information, see Hubspot's article [Private Apps](https://developers.hubspot.com/docs/api/private-apps){:target="_blank"}. + > warning "" > The HubSpot destination is not compatible with the Segment Event Tester. As result, Segment recommends using other tools to troubleshoot the HubSpot destination. - ## Getting Started {% include content/connection-modes.md %} 1. From the Segment web app, click **Catalog**. 2. Search for "HubSpot" in the Catalog, select it, and choose which of your sources to connect the destination to. -3. If you haven't already done so, add your API Key from [HubSpot](https://knowledge.hubspot.com/articles/kcs_article/integrations/how-do-i-get-my-hubspot-api-key) and enter it in the "API Key" field in the Segment web app. +3. Generate a Private App access token in [HubSpot](https://developers.hubspot.com/docs/api/private-apps){:target="_blank"} and enter it in the "Private App Token" field in the Segment web app. Segment requires the following scopes: `business-intelligence`, `crm.objects.contacts.read`, `crm.objects.contacts.write`, `crm.schemas.contacts.read`, `crm.objects.companies.read`, `crm.objects.companies.write`, `crm.schemas.companies.read`. Note: HubSpot no longer allows generation of new API Keys so you must authenticate with a Private App Token. 4. Navigate to the "Settings" page in the HubSpot UI to find your Hub ID and enter it to the "Hub ID" field in the Segment web app.