Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
4e81bd2
fixes
stayseesong Jul 29, 2022
91089f4
more fixes
stayseesong Aug 2, 2022
455581c
Merge pull request #517 from segmentio/repo-sync
bot-docsteam Aug 4, 2022
a34bd70
more fixes
stayseesong Aug 4, 2022
781da0b
Specified that A.js messages over 32kb result in a 500 error (#3334)
Aug 4, 2022
22c48f4
Merge pull request #3335 from segmentio/repo-sync
bot-docsteam Aug 4, 2022
06404a9
Merge pull request #518 from segmentio/repo-sync
bot-docsteam Aug 4, 2022
e338928
Merge branch 'master' into develop
stayseesong Aug 5, 2022
9d34ae8
Merge pull request #3337 from segmentio/repo-sync
bot-docsteam Aug 5, 2022
41fa695
Merge pull request #519 from segmentio/repo-sync
bot-docsteam Aug 5, 2022
6651efc
Add query parameter info to Computed Traits
rchinn1 Aug 8, 2022
2e23ad5
updating code sample per partners request
tlalfano Aug 8, 2022
526e7b4
Merge pull request #3341 from segmentio/tlalfano-patch-1
stayseesong Aug 8, 2022
66b64e9
Merge pull request #3342 from segmentio/repo-sync
bot-docsteam Aug 8, 2022
85427c5
Merge pull request #520 from segmentio/repo-sync
bot-docsteam Aug 8, 2022
bf1a0bf
Merge pull request #3340 from segmentio/Return-computed-traits-with-P…
rchinn1 Aug 9, 2022
4576fc8
Merge pull request #3343 from segmentio/repo-sync
bot-docsteam Aug 9, 2022
a839ffc
Merge pull request #521 from segmentio/repo-sync
bot-docsteam Aug 9, 2022
efbfd87
Remove Tracking Plan Google Sheet Reference
pwseg Aug 9, 2022
54369e6
add info for adid
Aug 9, 2022
1dbd432
add info for adid
Aug 9, 2022
3d57987
Add Target Attribute
pwseg Aug 9, 2022
3797812
Merge pull request #3346 from segmentio/niall/rn_ids
pwseg Aug 9, 2022
3cbd974
Merge pull request #3348 from segmentio/repo-sync
bot-docsteam Aug 9, 2022
3bd28e1
Merge pull request #522 from segmentio/repo-sync
bot-docsteam Aug 9, 2022
7535d00
Added line break (#3349)
Aug 9, 2022
01e5d49
Merge pull request #3351 from segmentio/repo-sync
bot-docsteam Aug 9, 2022
5970648
Merge pull request #3302 from segmentio/fixes-from-docs-dashboard-1
stayseesong Aug 9, 2022
176e182
Merge pull request #523 from segmentio/repo-sync
bot-docsteam Aug 9, 2022
17ccd69
Catalog update for August 9 (#3350)
Aug 9, 2022
c021468
Merge pull request #3352 from segmentio/repo-sync
bot-docsteam Aug 9, 2022
92bfb84
Merge pull request #524 from segmentio/repo-sync
bot-docsteam Aug 9, 2022
1ca478a
Merge pull request #3344 from segmentio/tracking-plan-template-fix
pwseg Aug 9, 2022
c1581d7
Merge pull request #3354 from segmentio/repo-sync
bot-docsteam Aug 9, 2022
442c6f8
Merge pull request #525 from segmentio/repo-sync
bot-docsteam Aug 9, 2022
868d34b
Update HubSpot docs for new privateAppToken auth
kdaswani Aug 9, 2022
d4f0e62
Formatting and edits
Aug 9, 2022
13803d5
Update index.md
kdaswani Aug 9, 2022
96ea94f
Merge pull request #3355 from segmentio/hubspot-private-app-auth
kdaswani Aug 10, 2022
536eda1
Merge pull request #3358 from segmentio/repo-sync
bot-docsteam Aug 10, 2022
acfc278
Merge pull request #526 from segmentio/repo-sync
bot-docsteam Aug 10, 2022
5a564ce
Fix campaign fields supported for GUA (#3359)
kdaswani Aug 10, 2022
51f9459
Add links about EMQ rating to FB CAPI Actions (#3356)
kdaswani Aug 10, 2022
53f3965
Merge pull request #3360 from segmentio/repo-sync
bot-docsteam Aug 10, 2022
feeccd0
Merge pull request #527 from segmentio/repo-sync
bot-docsteam Aug 10, 2022
c1b25e7
Add and hide Pardot Actions Docs
kdaswani Aug 11, 2022
ac7dffd
fixes
stayseesong Aug 11, 2022
33e8ae3
Merge pull request #3361 from segmentio/kiara/add-pardot-actions-docs
stayseesong Aug 11, 2022
326f8de
Merge pull request #3363 from segmentio/repo-sync
bot-docsteam Aug 11, 2022
1ca031b
Merge branch 'master' into develop
stayseesong Aug 11, 2022
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
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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)

Expand All @@ -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

Expand Down
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.
70 changes: 70 additions & 0 deletions src/connections/destinations/catalog/actions-pardot/index.md
Original file line number Diff line number Diff line change
@@ -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.

<!--- {% include components/actions-fields.html %} --->

## 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)
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions src/connections/destinations/catalog/hubspot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down