From 275b09f5fc0b26834f0278fd574bd1bb6c3b37be Mon Sep 17 00:00:00 2001 From: markzegarelli Date: Tue, 1 Feb 2022 09:39:14 -0800 Subject: [PATCH 1/4] Release 22.5.1 (#2443) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Adding admonition infrastructure * DOC-393 Taking it out of an admonition format and adding it to the paragraph above it * [DOC-393] Simplifying the information, adding it to the sentence before it * Fixes to Contributing page * small update to ga4 * Update CONTRIBUTING.md Frontmatter -> Front matter * Add note about Criteo connection modes with Analytics.js (#2437) * Add clarity to HubSpot API limit (#2436) * Update CONTRIBUTING.md * catalog update * Add Troubleshooting section to GEC docs (#2434) * add Troubleshooting section to GEC docs * style edits Co-authored-by: markzegarelli * redirect sprig actions (#2423) * remove connection table * Linking to FQL from Destination Filters doc (#2421) * Linking to FQL from Destination Filters doc * Update src/connections/destinations/destination-filters.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> * [byteplus] adding new destination folder in order to show new name in… (#2414) * [byteplus] adding new destination folder in order to show new name in docs URL * local links should be relative Co-authored-by: markzegarelli * Add region unsupported message for all cloud sources (#2422) * Add region unsupported message for all cloud sources * Remove spaces * prettify markdown * copy edits Co-authored-by: markzegarelli Co-authored-by: forstisabella <92472883+forstisabella@users.noreply.github.com> Co-authored-by: pwseg Co-authored-by: Segment Docs Robot <73141528+bot-docsteam@users.noreply.github.com> Co-authored-by: kdaswani <49517136+kdaswani@users.noreply.github.com> Co-authored-by: rchinn-segment <93161299+rchinn-segment@users.noreply.github.com> Co-authored-by: pwseg <86626706+pwseg@users.noreply.github.com> Co-authored-by: Niall Brennan Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> Co-authored-by: Thomas Gilbert <64277654+tcgilbert@users.noreply.github.com> Co-authored-by: jinapark202 <87985289+jinapark202@users.noreply.github.com> --- .vscode/yml.code-snippets | 4 - CONTRIBUTING.md | 20 +-- scripts/catalog_papi.js | 20 ++- src/_data/catalog/destination_categories.yml | 2 +- src/_data/catalog/destinations.yml | 114 ++++++------ src/_data/catalog/overrides.yml | 11 ++ src/_data/catalog/regional-supported.yml | 163 ++++++++++++------ src/_data/catalog/source_categories.yml | 2 +- src/_data/catalog/sources.yml | 2 +- src/_data/regional-support.yml | 43 +++++ src/_includes/content/destination-footer.md | 22 --- .../content/source-region-unsupported.md | 9 + src/config-api/fql.md | 107 +++++------- .../actions-google-analytics-4/index.md | 2 +- .../index.md | 15 ++ .../catalog/actions-sprig-web/index.md | 2 + .../destinations/catalog/byteplus/index.md | 67 ++++++- .../catalog/criteo-app-web-events/index.md | 13 +- .../destinations/catalog/hubspot/index.md | 2 +- .../destinations/destination-filters.md | 4 +- .../cloud-apps/activecampaign/index.md | 2 + .../catalog/cloud-apps/aircall/index.md | 2 + .../catalog/cloud-apps/airship/index.md | 2 + .../catalog/cloud-apps/amazon-s3/index.md | 2 + .../cloud-apps/amplitude-cohorts/index.md | 2 + .../catalog/cloud-apps/autopilothq/index.md | 3 + .../catalog/cloud-apps/beamer/index.md | 2 + .../catalog/cloud-apps/blueshift/index.md | 2 + .../sources/catalog/cloud-apps/braze/index.md | 2 + .../sources/catalog/cloud-apps/candu/index.md | 2 + .../catalog/cloud-apps/chatlio/index.md | 2 + .../catalog/cloud-apps/customer-io/index.md | 3 + .../catalog/cloud-apps/delighted/index.md | 3 + .../catalog/cloud-apps/desk-com/index.md | 1 + .../catalog/cloud-apps/facebook-ads/index.md | 2 + .../cloud-apps/facebook-lead-ads/index.md | 2 + .../cloud-apps/factual-engine/index.md | 2 + .../cloud-apps/foursquare-pilgrim/index.md | 2 + .../catalog/cloud-apps/friendbuy/index.md | 3 + .../catalog/cloud-apps/google-ads/index.md | 2 + .../sources/catalog/cloud-apps/herow/index.md | 2 + .../catalog/cloud-apps/hubspot/index.md | 2 + .../catalog/cloud-apps/intercom/index.md | 2 + .../catalog/cloud-apps/iterable/index.md | 3 + .../catalog/cloud-apps/klaviyo/index.md | 2 + .../catalog/cloud-apps/klenty/index.md | 3 + .../catalog/cloud-apps/launchdarkly/index.md | 3 + .../catalog/cloud-apps/leanplum/index.md | 2 + .../catalog/cloud-apps/looker/index.md | 3 + .../catalog/cloud-apps/mailchimp/index.md | 2 + .../catalog/cloud-apps/mailjet/index.md | 3 + .../catalog/cloud-apps/mandrill/index.md | 2 + .../catalog/cloud-apps/marketo/index.md | 2 + .../mixpanel-cohorts-source/index.md | 4 +- .../cloud-apps/mixpanel-cohorts/index.md | 1 + .../cloud-apps/moesif-api-analytics/index.md | 3 + .../catalog/cloud-apps/nudgespot/index.md | 3 + .../sources/catalog/cloud-apps/pendo/index.md | 3 + .../catalog/cloud-apps/provesource/index.md | 3 + .../sources/catalog/cloud-apps/radar/index.md | 2 + .../catalog/cloud-apps/refiner/index.md | 2 + .../catalog/cloud-apps/regal-voice/index.md | 2 + .../salesforce-marketing-cloud/index.md | 2 + .../catalog/cloud-apps/salesforce/index.md | 3 + .../selligent-marketing-cloud/index.md | 3 + .../catalog/cloud-apps/selligent/index.md | 3 + .../catalog/cloud-apps/sendgrid/index.md | 3 + .../cloud-apps/shopify-littledata/index.md | 2 + .../catalog/cloud-apps/stripe/index.md | 3 + .../twilio-event-streams-beta/index.md | 4 +- .../catalog/cloud-apps/twilio/index.md | 3 + .../sources/catalog/cloud-apps/vero/index.md | 3 + .../catalog/cloud-apps/wootric/index.md | 2 + .../catalog/cloud-apps/youbora/index.md | 2 + .../catalog/cloud-apps/zendesk/index.md | 2 + .../website/javascript/upgrade-to-ajs2.md | 2 +- 76 files changed, 517 insertions(+), 241 deletions(-) create mode 100644 src/_data/regional-support.yml create mode 100644 src/_includes/content/source-region-unsupported.md diff --git a/.vscode/yml.code-snippets b/.vscode/yml.code-snippets index a99498c89f..329fe8890f 100644 --- a/.vscode/yml.code-snippets +++ b/.vscode/yml.code-snippets @@ -21,8 +21,4 @@ "body":["- name: ${1:name}\r\tdescription: ${2:description}\r\tdefault: ${3}"], "description": "Yaml settings" }, - "ext_link":{ - "prefix": ["{:}"], - "body":["{:target='${1:_blank}'}"] - }, } \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4867c1bf5d..ffbc45271f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ Before you begin: ## Use the contribution links from any docs page -Not all pages have a 1-1 mapping with their location within the repository. This can make browsing and locating the file you're trying to reference a challenge. As you browse [segment.com/docs](https://segment.com/docs), you'll notice two links in the right sidebar, at the top of the page. Click **Edit this page** to open the page in the Github editor. Or, click **Request docs change** to create a new issue that references the page. +Not all pages have a 1-1 mapping with their location within the repository. This can make browsing and locating the file you're trying to reference a challenge. As you browse [segment.com/docs](https://segment.com/docs), you'll notice two links in the right sidebar, at the top of the page. Click **Edit this page** to open the page in the GitHub editor. Or, click **Request docs change** to create a new issue that references the page. ## Want to go deeper? Fork the repository @@ -39,7 +39,7 @@ The most interesting ones are: ### Images -**Save all images locally! No linking to 3rd party-hosted images!** Images are published to our CDN from the build step, and this means they won't go missing if the hosting service dujour goes out of business. +**Save all images locally! No linking to third-party hosted images!** Images are published to our CDN from the build step, and this means they won't go missing if the hosting service dujour goes out of business. There are no _enforced_ naming conventions at this time. Files that start with an underscore are ignored by Jekyll. Anything you see with `asset` was dowloaded by a script to migrate it out of Contents.io. @@ -77,11 +77,11 @@ Sources pages check if the source is a cloud-app, then include information about 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). -### Frontmatter +### Front matter -Each Markdown file in the docs can have "frontmatter" associated with it at the top of the file. These are considered by Jekyll to be "properties" of a page, generally control how the HTML page is built or rendered. +Repository Markdown files often contain front matter metadata, which you'll find at the top of the file. These front matter variables instruct Jekyll how to build and render the page as HTML. -Frontmatter in a file will look something like this: +Front matter in a file will look something like this: ```md --- @@ -90,11 +90,11 @@ hide-feedback: false --- ``` -Each piece of frontmatter does something special! +Front matter variables have unique functions, including the following: -#### Content-related frontmatter +#### Content-related front matter - `beta`: default false. When true, show an "in beta" warning in the page layout (see the warning in `_includes/content/beta-note.md`) -- `rewrite`: defaults to false. This is a legacy frontmatter flag that comes from the old `site-docs` repo, and which labels any destination that was rewritten in ~2018 to a standardized template. It disables the duplicate "connection modes" table that would otherwise show up in the boilerplate content at the end of the page. +- `rewrite`: defaults to false. This is a legacy front matter flag that comes from the old `site-docs` repo, and which labels any destination that was rewritten in ~2018 to a standardized template. It disables the duplicate "connection modes" table that would otherwise show up in the boilerplate content at the end of the page. - `hide-dossier`: defaults to false. When true, hides the "quick info" box at the top of a destination page. - `hide-boilerplate`: defaults to false. When true, none of the content from `destination-footer.md` is appended to the destination page. - `hide-cmodes`: defaults to false. A renaming of "rewrite" for more clarity, hides the connection modes table in the boilerplate. @@ -102,13 +102,13 @@ Each piece of frontmatter does something special! - `integration_type`: This is set in the `_config.yml` on three paths to add a noun (Source, Destination, or Warehouse) to the end of the title, and the end of the title tag in the html layout. It also controls the layout and icon for some of these. - `source-type`: These are only used to supplement when a Cloud App in the sources path doesn't appear in the Config API list, and needs its type explicitly set. It runs some logic in the `cloud-app-note.md` to explain which cloud-apps are object vs event sources. -#### Utility frontmatter +#### Utility front matter - `published`: defaults to true. Set this to "false" to prevent Jekyll from rendering an HTML page for this file. Good for when you're working on something in the repo but aren't ready to release it yet, and don't want to use a Draft PR. - `hidden`: omits the file from the `sitemap.xml`, adds a `` to the top of the generated HTML file, and drops it from the convenience script for regenerating the nav. - `hide-sidebar`: defaults to false. When true, hide the entire right-nav sidebar. Use with `hide-feedback` if you want to disable *all* feedback affordances. - `hide-feedback`: defaults to false. When true, hide the feedback in both rnav and footer. Good for landing pages. - `hide_toc`: hides the right-nav TOC that's generated from H2s. Also good for landing pages. - `landing`: defaults to false. Use this to drop the noun set by `integration_type` from the tab title. -- `redirect_from`: Defaults to null. Takes an array of URLs from the frontmatter in a file, and generates a "stub" page at each URL at build-time. Each stub file redirects to the original file. Use the path from the root of the content directory, for example `/connections/destinations/catalog/` rather than `/docs/connections/destinations/catalog/`. **Note** We are mostly using NGINX redirects for SEO purposes. Approximately quarterly, we'll collect these and add them to NGINX. +- `redirect_from`: Defaults to null. Takes an array of URLs from the front matter in a file, and generates a "stub" page at each URL at build-time. Each stub file redirects to the original file. Use the path from the root of the content directory, for example `/connections/destinations/catalog/` rather than `/docs/connections/destinations/catalog/`. **Note** We are mostly using NGINX redirects for SEO purposes. Approximately quarterly, we'll collect these and add them to NGINX. - `seo-changefreq`: default: `weekly `. Use the values [in the sitemap spec](https://www.sitemaps.org/protocol.html#xmlTagDefinitions). - sets the `changefreq` tag in the sitemap.xml generator, which tells search crawlers how often to check back. - `seo-priority`: values from `1.0` to `0.1`, default: `0.5 `. Sets the `Priority` tag in the sitemap diff --git a/scripts/catalog_papi.js b/scripts/catalog_papi.js index 37f4f0ab4a..4201b22dab 100644 --- a/scripts/catalog_papi.js +++ b/scripts/catalog_papi.js @@ -289,13 +289,14 @@ const updateSources = async () => { }, options); fs.writeFileSync(path.resolve(__dirname, `../src/_data/catalog/source_categories.yml`), output); - // Create reginal support map - output = "# AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL\n" - output += "# Last updated " + todayDate + " \n"; + + // output = "# AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL\n" + // output += "# Last updated " + todayDate + " \n"; output += yaml.dump({ sources: regionalSourcesUpdated }, options) - fs.writeFileSync(path.resolve(__dirname, `../src/_data/catalog/regional-supported.yml`), output); + fs.appendFileSync(path.resolve(__dirname, `../src/_data/catalog/regional-supported.yml`), output); + console.log("sources done") } const updateDestinations = async () => { @@ -482,6 +483,7 @@ const updateDestinations = async () => { noArrayIndent: false }) fs.appendFileSync(path.resolve(__dirname,`../src/_data/catalog/regional-supported.yml`),output); + console.log("destinations done") } const updateWarehouses = async () => { @@ -545,19 +547,23 @@ const updateWarehouses = async () => { noArrayIndent: true }; // output = "# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT\n" - // var todayDate = new Date().toISOString().slice(0, 10); + const todayDate = new Date().toISOString().slice(0, 10); // output += "# warehouse data last updated " + todayDate + " \n"; // output += yaml.dump({ // items: warehousesUpdated // }, options); // fs.writeFileSync(path.resolve(__dirname, `../src/_data/catalog/warehouse_papi.yml`), output); - output = yaml.dump({ + // Create regional support map + output = "# AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL\n" + output += "# Last updated " + todayDate + " \n"; + output += yaml.dump({ warehouses: warehousesUpdated }, { noArrayIndent: false }) - fs.appendFileSync(path.resolve(__dirname,`../src/_data/catalog/regional-supported.yml`),output); + fs.writeFileSync(path.resolve(__dirname,`../src/_data/catalog/regional-supported.yml`),output); + console.log("warehouses done") } updateSources() updateWarehouses() diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index 4dfdcead7c..9e4cd0db04 100644 --- a/src/_data/catalog/destination_categories.yml +++ b/src/_data/catalog/destination_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination categories last updated 2022-01-26 +# destination categories last updated 2022-02-01 items: - display_name: A/B Testing slug: a-b-testing diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index 2031d7e117..27bb310294 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination data last updated 2022-01-26 +# destination data last updated 2022-02-01 items: - destination_id: 60b5d0a01f3726b85dc05aab display_name: 2mee @@ -28839,6 +28839,63 @@ items: label: API Key actions: [] presets: [] +- destination_id: 5f2c35239094d175b6485eb1 + display_name: Sprig Cloud + name: Sprig Cloud + slug: sprig-cloud + hidden: false + regional: + - us-west + url: connections/destinations/catalog/sprig-cloud + previous_names: + - UserLeap + - Sprig + - Sprig Cloud + website: https://sprig.com + status: PUBLIC + categories: + - Analytics + - Customer Success + - Personalization + - Surveys + logo: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/74f53b6f-bc75-4132-b7de-1170cc57202e.svg + mark: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/d761456e-2b15-4401-87da-0c3fde847f5b.svg + methods: + track: true + identify: true + group: false + alias: true + page: true + platforms: + browser: true + mobile: true + server: true + components: [] + browserUnbundlingSupported: false + browserUnbundlingPublic: false + replay: false + connection_modes: + device: + web: false + mobile: false + server: false + cloud: + web: false + mobile: false + server: false + settings: + - name: apiKey + type: string + defaultValue: '' + description: Find your API key here https://app.userleap.com/settings/installation + required: true + label: API Key + actions: [] + presets: [] - destination_id: 5fa3ce52d18ccdfb384b13f7 display_name: Startdeliver name: Startdeliver @@ -31372,61 +31429,6 @@ items: label: API Key actions: [] presets: [] -- destination_id: 5f2c35239094d175b6485eb1 - display_name: UserLeap - name: UserLeap - slug: userleap - hidden: false - regional: - - us-west - url: connections/destinations/catalog/userleap - previous_names: - - UserLeap - website: https://sprig.com - status: PUBLIC_BETA - categories: - - Analytics - - Customer Success - - Personalization - - Surveys - logo: - url: >- - https://public-segment-devcenter-production.s3.amazonaws.com/74f53b6f-bc75-4132-b7de-1170cc57202e.svg - mark: - url: >- - https://public-segment-devcenter-production.s3.amazonaws.com/d761456e-2b15-4401-87da-0c3fde847f5b.svg - methods: - track: true - identify: true - group: false - alias: true - page: true - platforms: - browser: true - mobile: true - server: true - components: [] - browserUnbundlingSupported: false - browserUnbundlingPublic: false - replay: false - connection_modes: - device: - web: false - mobile: false - server: false - cloud: - web: false - mobile: false - server: false - settings: - - name: apiKey - type: string - defaultValue: '' - description: Find your API key here https://app.userleap.com/settings/installation - required: true - label: API Key - actions: [] - presets: [] - destination_id: 5c75396a02254a0001da2a55 display_name: Userlist name: Userlist diff --git a/src/_data/catalog/overrides.yml b/src/_data/catalog/overrides.yml index 9960604029..96c39ab231 100644 --- a/src/_data/catalog/overrides.yml +++ b/src/_data/catalog/overrides.yml @@ -1,6 +1,17 @@ # This file is manually generated. When you add or remove an item, add or remove # it from the `overrides-list.yml` too. items: +- slug: criteo-app-web-events + connection_modes: + connection_modes: + device: + web: true + mobile: false + server: false + cloud: + web: false + mobile: true + server: false - slug: doubleclick-floodlight connection_modes: device: diff --git a/src/_data/catalog/regional-supported.yml b/src/_data/catalog/regional-supported.yml index 3fb691926b..fc01d76f9b 100644 --- a/src/_data/catalog/regional-supported.yml +++ b/src/_data/catalog/regional-supported.yml @@ -1,5 +1,104 @@ # AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL -# Last updated 2022-01-26 +# Last updated 2022-02-01 +warehouses: + - id: WcjBCzUGff + display_name: Azure SQL Data Warehouse + url: connections/storage/catalog/azuresqldw + slug: azuresqldw + regional: + - us-west + - eu-west + - id: VxcZnH5UIM + display_name: Azure SQL Database + url: connections/storage/catalog/azuresqldb + slug: azuresqldb + regional: + - us-west + - eu-west + - id: kwX50Df0hr + display_name: BigQuery + url: connections/storage/catalog/bigquery + slug: bigquery + regional: + - us-west + - eu-west + - id: CUy2TYfDp0 + display_name: IBM Db2 Warehouse + url: connections/storage/catalog/db2 + slug: db2 + regional: + - us-west + - eu-west + - id: 55d3d3aea3c + display_name: Postgres + url: connections/storage/catalog/postgres + slug: postgres + regional: + - us-west + - eu-west + - id: aea3c55dsz + display_name: Redshift + url: connections/storage/catalog/redshift + slug: redshift + regional: + - us-west + - eu-west + - id: CCIl4HLQPz + display_name: Snowflake + url: connections/storage/catalog/snowflake + slug: snowflake + regional: + - us-west + - eu-west +# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT +# source cateogries last updated 2022-02-01 +items: + - display_name: A/B Testing + slug: a-b-testing + - display_name: Advertising + slug: advertising + - display_name: Analytics + slug: analytics + - display_name: analytics + slug: analytics + - display_name: CRM + slug: crm + - display_name: Custom + slug: custom + - display_name: Customer Success + slug: customer-success + - display_name: Email Marketing + slug: email-marketing + - display_name: Enrichment + slug: enrichment + - display_name: Feature Flagging + slug: feature-flagging + - display_name: Helpdesk + slug: helpdesk + - display_name: Livechat + slug: livechat + - display_name: Marketing Automation + slug: marketing-automation + - display_name: Mobile + slug: mobile + - display_name: Ott + slug: ott + - display_name: Payments + slug: payments + - display_name: Performance Monitoring + slug: performance-monitoring + - display_name: Personalization + slug: personalization + - display_name: Referrals + slug: referrals + - display_name: Server + slug: server + - display_name: SMS & Push Notifications + slug: sms-push-notifications + - display_name: Surveys + slug: surveys + - display_name: Website + slug: website sources: - id: 8HWbgPTt3k display_name: .NET @@ -464,56 +563,6 @@ sources: url: connections/sources/catalog/cloud-apps/zendesk regional: - us-west -warehouses: - - id: WcjBCzUGff - display_name: Azure SQL Data Warehouse - url: connections/storage/catalog/azuresqldw - slug: azuresqldw - regional: - - us-west - - eu-west - - id: VxcZnH5UIM - display_name: Azure SQL Database - url: connections/storage/catalog/azuresqldb - slug: azuresqldb - regional: - - us-west - - eu-west - - id: kwX50Df0hr - display_name: BigQuery - url: connections/storage/catalog/bigquery - slug: bigquery - regional: - - us-west - - eu-west - - id: CUy2TYfDp0 - display_name: IBM Db2 Warehouse - url: connections/storage/catalog/db2 - slug: db2 - regional: - - us-west - - eu-west - - id: 55d3d3aea3c - display_name: Postgres - url: connections/storage/catalog/postgres - slug: postgres - regional: - - us-west - - eu-west - - id: aea3c55dsz - display_name: Redshift - url: connections/storage/catalog/redshift - slug: redshift - regional: - - us-west - - eu-west - - id: CCIl4HLQPz - display_name: Snowflake - url: connections/storage/catalog/snowflake - slug: snowflake - regional: - - us-west - - eu-west destinations: - id: 60b5d0a01f3726b85dc05aab display_name: 2mee @@ -2231,6 +2280,12 @@ destinations: url: connections/destinations/catalog/split regional: - us-west + - id: 5f2c35239094d175b6485eb1 + display_name: Sprig Cloud + slug: sprig-cloud + url: connections/destinations/catalog/sprig-cloud + regional: + - us-west - id: 5fa3ce52d18ccdfb384b13f7 display_name: Startdeliver slug: startdeliver @@ -2412,12 +2467,6 @@ destinations: url: connections/destinations/catalog/useriq regional: - us-west - - id: 5f2c35239094d175b6485eb1 - display_name: UserLeap - slug: userleap - url: connections/destinations/catalog/userleap - regional: - - us-west - id: 5c75396a02254a0001da2a55 display_name: Userlist slug: userlist diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml index 93bfb95bf1..15dfd1a818 100644 --- a/src/_data/catalog/source_categories.yml +++ b/src/_data/catalog/source_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# source cateogries last updated 2022-01-26 +# source cateogries last updated 2022-02-01 items: - display_name: A/B Testing slug: a-b-testing diff --git a/src/_data/catalog/sources.yml b/src/_data/catalog/sources.yml index 984baf00c3..c3f13a19da 100644 --- a/src/_data/catalog/sources.yml +++ b/src/_data/catalog/sources.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# sources last updated 2022-01-26 +# sources last updated 2022-02-01 items: - id: 8HWbgPTt3k display_name: .NET diff --git a/src/_data/regional-support.yml b/src/_data/regional-support.yml new file mode 100644 index 0000000000..71518f18ab --- /dev/null +++ b/src/_data/regional-support.yml @@ -0,0 +1,43 @@ +sources: + - factual-engine + - net + - amp + - android + - clojure + - go + - http-api + - ios + - java + - javascript + - kotlin + - kotlin-android + - node-js + - php + - pixel-tracking-api + - react-native + - roku + - ruby + - xamarin +destinations: + - amplitude + - mixpanel + - braze + - repeater + - slack + - stitch-data + - adobe-analytics + - natero + - iron-io + - ibm-ubx + - actions-amplitude + - gainsight-px + - braze-cloud-mode-actions + - braze-web-mode-actions +warehouses: + - azuresqldb + - azuresqldw + - bigquery + - db2 + - postgres + - redshift + - snowflake \ No newline at end of file diff --git a/src/_includes/content/destination-footer.md b/src/_includes/content/destination-footer.md index 6a49e91c8e..a7d958177f 100644 --- a/src/_includes/content/destination-footer.md +++ b/src/_includes/content/destination-footer.md @@ -20,28 +20,6 @@ When you first create an audience, Personas sends an Identify call for every use {% endif %} -{% unless page.rewrite == true or page.hide-cmodes == true%} -## Supported Sources and Connection Modes -{% if currentIntegration.components.size > 0 %} -{% include content/connection-modes.md %} - -{% endif %} - -{% if currentIntegration.browserUnbundlingSupported == true and currentIntegration.browserUnbundlingPublic == true %} - Segment offers an optional **Cloud-based** Connection Mode for **Web** data with {{ currentIntegration.display_name }}. As a reminder, this removes the {{ currentIntegration.display_name }} javascript library from your site, improving performance. -{% endif %} - -{% unless page.hide-device == true %} -{% if currentIntegration.platforms.mobile == true %} - {% if currentIntegration.platforms.server == true %} - Segment offers an *optional* **Device-based** Connection Mode for **Mobile** data going to {{ currentIntegration.display_name }}, so that you can use {{ currentIntegration.display_name }} features that collect data directly from the mobile device. To do this, you must package the Segment-{{ currentIntegration.display_name }} mobile SDK with the Segment mobile library. - {% else %} - This destination *requires* that you use a **Device-based** Connection Mode for **Mobile** data. Make sure you package the {{ currentIntegration.display_name }} mobile SDK with the Segment mobile library. - {% endif %} -{% endif %} -{% endunless %} -{% endunless %} - {% unless page.hide-settings == true %} ## Settings Segment lets you change these destination settings from the Segment app without having to touch any code. diff --git a/src/_includes/content/source-region-unsupported.md b/src/_includes/content/source-region-unsupported.md new file mode 100644 index 0000000000..672307a2f1 --- /dev/null +++ b/src/_includes/content/source-region-unsupported.md @@ -0,0 +1,9 @@ +
+
+
+

This {{ page.integration_type }} is supported in US data processing regions.

+

+ The {{ page.title | replace: 'Source', '' }} source is only supported in workspaces configured to process data in the US region. Workspaces configured with data processing regions outside of the US cannot connect to this source. For more information, see [Regional Segment](/docs/guides/regional-segment/). +

+
+
diff --git a/src/config-api/fql.md b/src/config-api/fql.md index 4082c3dc1d..96394be59c 100644 --- a/src/config-api/fql.md +++ b/src/config-api/fql.md @@ -1,19 +1,12 @@ --- title: Destination Filter Query Language -hidden: true --- Destination Filter Reference documentation can be found in the [main Config API reference docs](https://reference.segmentapis.com/#6c12fbe8-9f84-4a6c-848e-76a2325cb3c5). -Filter Query Language ("FQL") is a simple language for filtering JSON objects -used by the Transformations API to conditionally apply transformations. In the -Transformations API, FQL statements evaluate to `true` or `false` based on the -contents of each Segment event. If the statement evaluates to `true`, the -transformation is applied, and if it is `false` the transformation is not applied. +Filter Query Language ("FQL") is a simple language for filtering JSON objects used by the Transformations API to conditionally apply transformations. In the Transformations API, FQL statements evaluate to `true` or `false` based on the contents of each Segment event. If the statement evaluates to `true`, the transformation is applied, and if it is `false` the transformation is not applied. -In addition to boolean and equality operators like `and` and `>=`, FQL has -built-in functions that make it more powerful such as `contains( str, substr )` -and `match( str, pattern )`. +In addition to boolean and equality operators like `and` and `>=`, FQL has built-in functions that make it more powerful such as `contains( str, substr )` and `match( str, pattern )`. ## Examples @@ -53,7 +46,7 @@ properties like `userId` or `event` as well as nested properties like `context.library.version` or `properties.title` using dot-separated paths. For example, the following fields can be pointed to by the associated field paths: -``` +```json { "type": "...", // type "event": "...", // event @@ -70,9 +63,7 @@ example, the following fields can be pointed to by the associated field paths: ### Escaping Field Paths -If your field name has a character not in the set of `{a-z A-Z 0-9 _ -}`, you -must escape it using a `\` character. For example, the nested field -below can be referred to by `properties.product\ 1.price`: +If your field name has a character not in the set of `{a-z A-Z 0-9 _ -}`, you must escape it using a `\` character. For example, the nested field below can be referred to by `properties.product\ 1.price`: ```json { @@ -96,7 +87,7 @@ below can be referred to by `properties.product\ 1.price`: ### Unary | Operator | Right Side | Result | -|----------|------------|------------------------------| +| -------- | ---------- | ---------------------------- | | `!` | `bool` | Negates the right-hand side. | ### Comparison @@ -112,30 +103,29 @@ below can be referred to by `properties.product\ 1.price`: ## Subexpressions -You can use parentheses to group subexpressions for more complex "and / or" -logic as long as the subexpression evaluates to true or false: +You can use parentheses to group subexpressions for more complex "and / or" logic as long as the subexpression evaluates to true or false: -| FQL | -| ------------------------------------------------------------------------------------------------------------------------------ | -| `type = 'track' and ( event = 'Click' or match( 'Button *', event ) )` | -| `( type = 'track' or type = 'identify' ) and ( properties.enabled or match( traits.email, '*@company.com' ) )` | +| FQL | +| -------------------------------------------------------------------------------------------------------------- | +| `type = 'track' and ( event = 'Click' or match( 'Button *', event ) )` | +| `( type = 'track' or type = 'identify' ) and ( properties.enabled or match( traits.email, '*@company.com' ) )` | ## Functions -| Function | Return Type | Result | -| ----------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contains( s string, sub string )` | `bool` | Returns `true` if string `s` contains string `sub`. | +| Function | Return Type | Result | +| ----------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `contains( s string, sub string )` | `bool` | Returns `true` if string `s` contains string `sub`. | | `length( list or string )` | `number` | Returns the number of elements in a list or number of bytes (not necessarily characters) in a string. For example, `a` is 1 byte and`ア` is 3 bytes long. | -| `lowercase( s string )` | `string` | Returns `s` with all uppercase characters replaced with their lowercase equivalent. | -| `typeof( value )` | `string` | Returns the type of the given value: `"string"`, `"number"`, `"list"`, `"bool"`, or `"null"`. | -| `match( s string, pattern string )` | `bool` | Returns `true` if the glob pattern `pattern` matches `s`. See below for more details about glob matching. | +| `lowercase( s string )` | `string` | Returns `s` with all uppercase characters replaced with their lowercase equivalent. | +| `typeof( value )` | `string` | Returns the type of the given value: `"string"`, `"number"`, `"list"`, `"bool"`, or `"null"`. | +| `match( s string, pattern string )` | `bool` | Returns `true` if the glob pattern `pattern` matches `s`. See below for more details about glob matching. | Functions handle `null` with sensible defaults to make writing FQL more concise. For example, you can write `length( userId ) > 0` instead of `typeof( userId ) = 'string' and length( userId ) > 0`. | Function | Result | -|----------------------------|----------| +| -------------------------- | -------- | | `contains( null, string )` | `false` | | `length( null )` | `0` | | `lowercase( null )` | `null` | @@ -144,39 +134,30 @@ For example, you can write `length( userId ) > 0` instead of `typeof( userId ) = ### `match( string, pattern )` -The `match( string, pattern )` function uses "glob" matching to return `true` if -the given string fully matches a given pattern. Glob patterns are case -sensitive. If you only need to determine if a string contains a given substring, -you should use `contains()`. - -| Pattern | Summary | -| ------- | -------------------------------------------------------------------------------------------------------------- | -| `*` | Matches zero or more characters. | -| `?` | Matches one character. | -| `[abc]` | Matches one character in the given list. In this case, `a`, `b`, or `c` will be matched. | -| `[a-z]` | Matches a range of characters. In this case, any lowercase letter will be matched. | -| `\x` | Matches the character `x` literally. This is useful if you need to match `*`, `?` or `]` literally. E.g. `\*`. | - -| Pattern | Result | Reason | -| -------------------------------- | ------- | ------------------------------------------------------------------------------------------------------- | -| `match(` `'abcd', 'a*d' )` | `true` | `*` matches zero or more characters. | -| `match( '', '*' )` | `true` | `*` matches zero or more characters. | -| `match( 'abc', 'ab' )` | `false` | The pattern must match the full string. | -| `match( 'abcd', 'a??d' )` | `true` | `?` matches one character only. | -| `match( 'abcd', '*d' )` | `true` | `*` matches one or more characters even at the beginning or end of the string. | -| `match( 'ab*d', 'ab\*d' )` | `true` | `\*` matches the literal character `*`. | -| `match( 'abCd', 'ab[cC]d' )` | `true` | `[cC]` matches either `c` or `C`. | -| `match( 'abcd', 'ab[a-z]d' )` | `true` | `[a-z]` matches any character between `a` and `z`. | -| `match( 'abcd', 'ab[A-Z]d' )` | `false` | `[A-Z]` matches any character between `A` and `Z` but `c` is not in that range because it is lowercase. | - -## Errata - -### Error Handling - -If your FQL statement is invalid (for example `userId = oops"`), your Segment -event will not be sent on to downstream Destinations. We default to not sending -the event to ensure that invalid FQL doesn't cause sensitive information like -PII to be incorrectly sent to Destinations. - -For this reason, we strongly recommend that you use the Destination Filters -"Preview" API to test your filters without impacting your production data. +The `match( string, pattern )` function uses "glob" matching to return `true` if the given string fully matches a given pattern. Glob patterns are case sensitive. If you only need to determine if a string contains a given substring, you should use `contains()`. + +| Pattern | Summary | +| ------- | ---------------------------------------------------------------------------------------------------------------------- | +| `*` | Matches zero or more characters. | +| `?` | Matches one character. | +| `[abc]` | Matches one character in the given list. In this case, `a`, `b`, or `c` will be matched. | +| `[a-z]` | Matches a range of characters. In this case, any lowercase letter will be matched. | +| `\x` | Matches the character `x` literally. This is useful if you need to match `*`, `?` or `]` literally. For example, `\*`. | + +| Pattern | Result | Reason | +| ----------------------------- | ------- | ------------------------------------------------------------------------------------------------------- | +| `match(` `'abcd', 'a*d' )` | `true` | `*` matches zero or more characters. | +| `match( '', '*' )` | `true` | `*` matches zero or more characters. | +| `match( 'abc', 'ab' )` | `false` | The pattern must match the full string. | +| `match( 'abcd', 'a??d' )` | `true` | `?` matches one character only. | +| `match( 'abcd', '*d' )` | `true` | `*` matches one or more characters even at the beginning or end of the string. | +| `match( 'ab*d', 'ab\*d' )` | `true` | `\*` matches the literal character `*`. | +| `match( 'abCd', 'ab[cC]d' )` | `true` | `[cC]` matches either `c` or `C`. | +| `match( 'abcd', 'ab[a-z]d' )` | `true` | `[a-z]` matches any character between `a` and `z`. | +| `match( 'abcd', 'ab[A-Z]d' )` | `false` | `[A-Z]` matches any character between `A` and `Z` but `c` is not in that range because it is lowercase. | + +## Error Handling + +If your FQL statement is invalid (for example `userId = oops"`), your Segment event will not be sent on to downstream Destinations. Segment defaults to not sending the event to ensure that invalid FQL doesn't cause sensitive information like PII to be incorrectly sent to Destinations. + +For this reason, Segment recommends that you use the Destination Filters "Preview" API to test your filters without impacting your production data. diff --git a/src/connections/destinations/catalog/actions-google-analytics-4/index.md b/src/connections/destinations/catalog/actions-google-analytics-4/index.md index bee0a8f770..ce1b9b2078 100644 --- a/src/connections/destinations/catalog/actions-google-analytics-4/index.md +++ b/src/connections/destinations/catalog/actions-google-analytics-4/index.md @@ -52,7 +52,7 @@ Google Analytics 4 is also case sensitive. If you would like all event names low Segment sends a Google `clientId` in requests to the Measurement Protocol API, alongside other required API fields. However, user sessions are [not currently supported by the Measurement Protocol API](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/limitations){:target="_blank"}, so user metrics might not appear on the Google Analytics 4 Realtime report or several other reports. -To validate your implementation, check users on the Events report and User Explorer. You can also confirm events are picked up in the Realtime report. +To validate your implementation, check users and events on the Events report and User Explorer. ### Debug Mode diff --git a/src/connections/destinations/catalog/actions-google-enhanced-conversions/index.md b/src/connections/destinations/catalog/actions-google-enhanced-conversions/index.md index 9641a21748..8bec9a0aa1 100644 --- a/src/connections/destinations/catalog/actions-google-enhanced-conversions/index.md +++ b/src/connections/destinations/catalog/actions-google-enhanced-conversions/index.md @@ -74,3 +74,18 @@ To test your mapping: {% endcapture %} {% include components/actions-fields.html content1=conv_label section1="postConversion" content2=test_mapping section2="postConversion" %} + +## Troubleshooting +Follow the steps below if you have issues with Access Tokens or Conversion tracking. + +### Refreshing Access Tokens + +When you use OAuth to authenticate into the Google Enhanced Conversions destination, Segment stores an access token and refresh token. Access tokens for Google Enhanced Conversions expire after one hour. Once expired, Segment receives an error and then uses the refresh token to fetch a new access token. This results in two API requests to Google Enhanced Conversions, one failure and one success. + +Because of the duplicate API requests, you may see a warning in Google for unprocessed conversions due to incorrect or missing OAuth credentials. This warning is expected and does not indicate data loss. Google has confirmed that conversions are being processed, and OAuth retry behavior will not cause any issues for your web conversions. Whenever possible, Segment caches access tokens to reduce the total number of requests we make to Google Enhanced Conversions. + +### Conversion Tracking with Gtag + +To use Google Enhanced Conversions, you must record conversions using the standard Google Ads Conversion tag (Gtag). After a conversion is recorded, you can send hashed first-party data through Segment’s Google Enhanced Conversions destination for up to 24 hours after the conversion. Segment offers a [Google Ads (Gtag) destination](/docs/connections/destinations/catalog/google-ads-gtag/) so you can use your existing Segment implementation to activate Gtag. + +Conversions tracked by other means, such as importing goals from Google Analytics, are not eligible for Google Enhanced Conversions. diff --git a/src/connections/destinations/catalog/actions-sprig-web/index.md b/src/connections/destinations/catalog/actions-sprig-web/index.md index f69fbf48da..1fc5e3bb80 100644 --- a/src/connections/destinations/catalog/actions-sprig-web/index.md +++ b/src/connections/destinations/catalog/actions-sprig-web/index.md @@ -4,6 +4,8 @@ title: Sprig (Actions) Destination hide-boilerplate: true hide-dossier: true hidden: true +redirect_from: + - '/connections/destinations/catalog/sprig-web' --- diff --git a/src/connections/destinations/catalog/byteplus/index.md b/src/connections/destinations/catalog/byteplus/index.md index 6794a7e1d3..8091bea811 100644 --- a/src/connections/destinations/catalog/byteplus/index.md +++ b/src/connections/destinations/catalog/byteplus/index.md @@ -1,6 +1,67 @@ --- -title: 'BytePlus Destination' -hidden: true -published: false +rewrite: true +title: BytePlus +redirect_from: + - '/connections/destinations/catalog/datarangers/' beta: true --- + +BytePlus provides product analytics for mobile and web applications, including event/retention/funnel/error analysis, user segmentation, user paths, behavior lookup, A/B testing, and other functions. + +In addition to the docs below, please reference the [BytePlus integration guide](https://docs.byteplus.com/data-intelligence/docs/sdk-integration-1){:target="_blank"}. + +This destination is maintained by BytePlus. For any issues with the destination, please [contact the BytePlus Support team](mailto:support@byteplus.com) + +## Getting Started + +{% include content/connection-modes.md %} + + +1. From the Destinations catalog page in the Segment App, click **Add Destination**. +2. Search for "BytePlus" in the Destinations Catalog, and select the "BytePlus" destination. +3. Choose which Source should send data to the "BytePlus" destination. +4. In BytePlus, go to your "[Organization Settings](https://docs.byteplus.com/data-intelligence/docs/create-your-organizations-and-projects)" > "Project List" and find the targeted project. +5. Click on **Details** for the targeted project and find the API key ("App Key") on the pop-out information page. This should be a 32-character string of numbers and letters. +6. Enter the "API Key" in the "BytePlus" destination settings in Segment. + + +## Page + +If you aren’t familiar with the Segment Spec, take a look at the Page method documentation (/docs/connections/spec/page/) to learn about what it does. An example call would look like: + + +```js +analytics.page() +``` + + +Segment sends Page calls to BytePlus as a `page` event. + +## Screen + +If you aren’t familiar with the Segment Spec, take a look at the [Screen method documentation](/docs/connections/spec/screen/) to learn about what it does. An example call would look like: +```obj-c +[[SEGAnalytics sharedAnalytics] screen:@"Home"]; +``` + +Segment sends Screen calls to BytePlus as a`screen`event. + +## Identify + +If you aren’t familiar with the Segment Spec, take a look at the [Identify method documentation](/docs/connections/spec/identify/) to learn about what it does. An example call would look like: + +```js +analytics.identify('userId123', { + email: 'john.doe@example.com' +}); +``` +Segment sends Identify calls to BytePlus as an `identify `event with `SSID`. + +## Track + +If you aren’t familiar with the Segment Spec, take a look at the [Track method documentation](/docs/connections/spec/track/) to learn about what it does. An example call would look like: +```js +analytics.track('Login Button Clicked') +``` +Segment sends Track calls to BytePlus as a `track` event with event name and properties. + diff --git a/src/connections/destinations/catalog/criteo-app-web-events/index.md b/src/connections/destinations/catalog/criteo-app-web-events/index.md index dd7e5858dc..8b055671b2 100644 --- a/src/connections/destinations/catalog/criteo-app-web-events/index.md +++ b/src/connections/destinations/catalog/criteo-app-web-events/index.md @@ -1,28 +1,23 @@ --- title: Criteo App & Web Events Destination rewrite: true +cmode-override: true +hide-cmodes: true redirect_from: '/connections/destinations/catalog/criteo/' --- ## Getting Started -{% include content/connection-modes.md %} +> info "Information about Criteo App & Web Events and Analytics.js" +> If you connect the Criteo App & Web Events destination to an Analytics.js source, the connection defaults to Device-mode. Cloud-mode connections are not available with Analytics.js. Currently this destination supports events originating from Mobile or Web sources (not Server). You can read more [about sources here](/docs/connections/sources/). -**Our web integration with Criteo Events is currently in public beta. Use carefully and [contact us](https://segment.com/help/contact) if you are having any issues.** - To get started with Criteo Events and Segment, you'll need: 1. An existing account with [Criteo](http://www.criteo.com/). 2. A data source integrated with either one of our mobile SDK's ([iOS](/docs/connections/sources/catalog/libraries/mobile/ios/) or [Android](/docs/connections/sources/catalog/libraries/mobile/android/)) or Javascript library ([Analytics.js](/docs/connections/sources/catalog/libraries/website/javascript/)) -Assuming both of these criteria are met, you can add Criteo Events as a destination for your desired source in your Segment account. - -**If you are using our mobile integration with Criteo Events make sure your app is properly registered with them.** - - -- - - ## Track diff --git a/src/connections/destinations/catalog/hubspot/index.md b/src/connections/destinations/catalog/hubspot/index.md index ba0483ae0c..a3e04da2a1 100644 --- a/src/connections/destinations/catalog/hubspot/index.md +++ b/src/connections/destinations/catalog/hubspot/index.md @@ -105,7 +105,7 @@ In this case, your HubSpot `eventId` is 'Bought Item'. If you want to use an exi #### Setting Contact Properties on Track -Segment recommends that you send `traits` with an [Identify](/docs/connections/spec/identify/) call. You can also set HubSpot properties on a track call sent from any server-side source, as allowed by Hubspot's [events API](http://developers.hubspot.com/docs/methods/enterprise_events/http_api){:target="_blank"}. You might want to use this method if you're running out of API calls on the Identify requests. +Segment recommends that you send `traits` with an [Identify](/docs/connections/spec/identify/) call. You can also set HubSpot properties on a track call sent from any server-side source, as allowed by Hubspot's [events API](http://developers.hubspot.com/docs/methods/enterprise_events/http_api){:target="_blank"}. Segment recommends this method if you're running out of HubSpot API calls on the Identify requests. Include HubSpot contact properties into the `context.traits` object: diff --git a/src/connections/destinations/destination-filters.md b/src/connections/destinations/destination-filters.md index af9e660e94..82a182ee47 100644 --- a/src/connections/destinations/destination-filters.md +++ b/src/connections/destinations/destination-filters.md @@ -15,7 +15,7 @@ Common use cases for Destination Filters include the following: - Preventing test or internally-generated events from reaching your production tools > note "" -> **Note**: Destination Filters are available to Business Tier customers only. +> Destination Filters are available to Business Tier customers only. ### Destination Filtering Limitations @@ -42,7 +42,7 @@ To create a Destination Filter, follow these steps: ## Destination Filters API -The Destination Filters API provides more power than the Segment dashboard's Destination Filters settings. With the API, You can create complex filters that are conditionally applied using Segment's Filter Query Language (FQL). +The Destination Filters API provides more power than the Segment dashboard's Destination Filters settings. With the API, you can create complex filters that are conditionally applied using Segment's [Filter Query Language (FQL)](/docs/config-api/fql). The Destination Filters API offers four different filter types: diff --git a/src/connections/sources/catalog/cloud-apps/activecampaign/index.md b/src/connections/sources/catalog/cloud-apps/activecampaign/index.md index e671bcfa8a..49034d5570 100644 --- a/src/connections/sources/catalog/cloud-apps/activecampaign/index.md +++ b/src/connections/sources/catalog/cloud-apps/activecampaign/index.md @@ -2,6 +2,8 @@ title: ActiveCampaign Source --- +{% include content/source-region-unsupported.md %} + Active Campaign is an email marketing & marketing automation solution for small businesses. [Visit Website](http://www.activecampaign.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) Take your company's email analysis to the next level by **adding ActiveCampaign as a Source to Segment.** Segment automatically collects email events like `Email Delivered` and `Email Opened`, forward them to your destinations, and load them into your data warehouse.  diff --git a/src/connections/sources/catalog/cloud-apps/aircall/index.md b/src/connections/sources/catalog/cloud-apps/aircall/index.md index 6ffbeca686..53d5f3b6aa 100644 --- a/src/connections/sources/catalog/cloud-apps/aircall/index.md +++ b/src/connections/sources/catalog/cloud-apps/aircall/index.md @@ -2,6 +2,8 @@ title: Aircall Source --- +{% include content/source-region-unsupported.md %} + Connect [Aircall](https://aircall.io) with Segment to bring Aircall events and phone call data to your data warehouse. Improve your knowledge of customer touchpoints by leveraging call activity. This source is maintained by Aircall. For any issues with the source, [contact the Aircall Support team](mailto:support@aircall.io). diff --git a/src/connections/sources/catalog/cloud-apps/airship/index.md b/src/connections/sources/catalog/cloud-apps/airship/index.md index fc19ffb5e4..d24aa9e268 100644 --- a/src/connections/sources/catalog/cloud-apps/airship/index.md +++ b/src/connections/sources/catalog/cloud-apps/airship/index.md @@ -2,6 +2,8 @@ title: Airship Source --- +{% include content/source-region-unsupported.md %} + [Airship](https://www.airship.com) gives brands the data, channels, orchestration and services they need to deliver push notifications, emails, SMS, in-app messages, and more to the right person at the right moment — building trust, boosting engagement, driving action and growing value. Real-Time Data Streaming automatically collects user-level data and sends the data to Segment for analysis or action through other Destination integrations. At Airship, we understand that seamlessly tying data across platforms can be a complex task. This integration removes the development so users can get back to understanding their audience and reaching them on their preferred channel. diff --git a/src/connections/sources/catalog/cloud-apps/amazon-s3/index.md b/src/connections/sources/catalog/cloud-apps/amazon-s3/index.md index 05dbbe1bac..ff3013b5fe 100644 --- a/src/connections/sources/catalog/cloud-apps/amazon-s3/index.md +++ b/src/connections/sources/catalog/cloud-apps/amazon-s3/index.md @@ -3,6 +3,8 @@ title: Amazon S3 from Lambda rewrite: true --- +{% include content/source-region-unsupported.md %} + This document contains a procedure that enables you to upload a CSV file containing data to Amazon S3, where it uses Lambda to automatically parse, format, and upload the data to Segment. You might have sources of data where you can't instrument Segment's SDKs, including other SaaS tools for which a Segment integration is not yet available. In many of these cases, you can extract data from these sources in CSV format, and then use our server-side SDKs or HTTP tracking API to push the data to Segment. diff --git a/src/connections/sources/catalog/cloud-apps/amplitude-cohorts/index.md b/src/connections/sources/catalog/cloud-apps/amplitude-cohorts/index.md index e3c5aab7b0..1f17f45649 100644 --- a/src/connections/sources/catalog/cloud-apps/amplitude-cohorts/index.md +++ b/src/connections/sources/catalog/cloud-apps/amplitude-cohorts/index.md @@ -2,6 +2,8 @@ title: Amplitude Engage Event Source --- +{% include content/source-region-unsupported.md %} + This source combines Amplitude's analytics with Segment's rich connections ecosystem. This allows you to export Behavioral Cohorts from Amplitude to Segment so that you can better target users across their many downstream diff --git a/src/connections/sources/catalog/cloud-apps/autopilothq/index.md b/src/connections/sources/catalog/cloud-apps/autopilothq/index.md index f1cb5666e9..e28fcf00f1 100644 --- a/src/connections/sources/catalog/cloud-apps/autopilothq/index.md +++ b/src/connections/sources/catalog/cloud-apps/autopilothq/index.md @@ -1,6 +1,9 @@ --- title: Autopilot Source --- + +{% include content/source-region-unsupported.md %} + [Autopilot](https://autopilothq.com/) makes automating customer journeys as simple as drawing on a whiteboard. Engage at just the right time with personalized emails, in-app messages, SMS, and postcards. Take your company's email analysis to the next level by adding Autopilot as a Source to Segment. Segment automatically collects email events like Email Delivered and Email Opened, forwards them to your destinations, and loads them into your data warehouse. diff --git a/src/connections/sources/catalog/cloud-apps/beamer/index.md b/src/connections/sources/catalog/cloud-apps/beamer/index.md index 0e19439cc6..4093b93b76 100644 --- a/src/connections/sources/catalog/cloud-apps/beamer/index.md +++ b/src/connections/sources/catalog/cloud-apps/beamer/index.md @@ -3,6 +3,8 @@ title: Beamer Source beta: true --- +{% include content/source-region-unsupported.md %} + [Beamer](https://www.getbeamer.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a changelog and notification center that lets you announce new features, product updates, special offers and more. This source is maintained by Beamer. For any issues with the source, [contact the Beamer Support team](mailto:info@getbeamer.com). diff --git a/src/connections/sources/catalog/cloud-apps/blueshift/index.md b/src/connections/sources/catalog/cloud-apps/blueshift/index.md index e2d5816341..116eca65dc 100644 --- a/src/connections/sources/catalog/cloud-apps/blueshift/index.md +++ b/src/connections/sources/catalog/cloud-apps/blueshift/index.md @@ -2,6 +2,8 @@ title: Blueshift Source --- +{% include content/source-region-unsupported.md %} + Blueshift is an AI powered customer engagement platform for growth marketers. With Blueshift, you can set up programmatic cross-channel marketing campaigns across Email, Mobile, Website and other channels. Take your company's email analysis to the next level by adding Blueshift as a Source to Segment. Segment automatically collects email events like **Email Delivered** and **Email Opened**, forward them to your destinations, and load them into your data warehouse. diff --git a/src/connections/sources/catalog/cloud-apps/braze/index.md b/src/connections/sources/catalog/cloud-apps/braze/index.md index 9e90e34387..dd6ff25440 100644 --- a/src/connections/sources/catalog/cloud-apps/braze/index.md +++ b/src/connections/sources/catalog/cloud-apps/braze/index.md @@ -2,6 +2,8 @@ title: Braze Source --- +{% include content/source-region-unsupported.md %} + [Braze](https://www.braze.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a marketing automation and customer engagement platform. Growth, Engagement, and Marketing teams use Braze to build great long term relationships with their customers across key digital channels. Take your company's marketing and customer engagement to the next level by adding Braze as a Segment Source, using Braze's Currents product. Segment automatically collects marketing and analytics events, forwards them to your destinations, and loads them into your data warehouse. diff --git a/src/connections/sources/catalog/cloud-apps/candu/index.md b/src/connections/sources/catalog/cloud-apps/candu/index.md index 857f7bb0a3..71e5d74556 100644 --- a/src/connections/sources/catalog/cloud-apps/candu/index.md +++ b/src/connections/sources/catalog/cloud-apps/candu/index.md @@ -4,6 +4,8 @@ beta: true source-type: event --- +{% include content/source-region-unsupported.md %} + [Candu](https://candu.ai/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is the first UI editor for enterprise applications that allows you to drag and drop your own UI components to build product experiences — no coding required. Candu’s Source integration automatically returns user interaction data to Segment, where you can join it with production data. This allows you to understand how a user’s interactions with Candu content drive downstream behaviors, such as feature adoption and renewal. diff --git a/src/connections/sources/catalog/cloud-apps/chatlio/index.md b/src/connections/sources/catalog/cloud-apps/chatlio/index.md index 0563b31d47..0bdcfd5abd 100644 --- a/src/connections/sources/catalog/cloud-apps/chatlio/index.md +++ b/src/connections/sources/catalog/cloud-apps/chatlio/index.md @@ -3,6 +3,8 @@ title: Chatlio Source beta: true --- +{% include content/source-region-unsupported.md %} + Chatlio is a live chat tool that allows you to talk to your customers through your existing Slack service. Chatlio provides built in support for sending [chat related events](https://segment.com/docs/connections/spec/live-chat/) to Segment to give you a full picture of activity on your site including live chat. Visit [Chatlio for more info](https://chatlio.com/). ## Getting Started diff --git a/src/connections/sources/catalog/cloud-apps/customer-io/index.md b/src/connections/sources/catalog/cloud-apps/customer-io/index.md index c9b9636aed..668510461e 100644 --- a/src/connections/sources/catalog/cloud-apps/customer-io/index.md +++ b/src/connections/sources/catalog/cloud-apps/customer-io/index.md @@ -2,6 +2,9 @@ title: Customer.io Source redirect_from: "/connections/sources/catalog/cloud-apps/customer.io/" --- + +{% include content/source-region-unsupported.md %} + [Customer.io](https://customer.io/) is an automated email tool. It lets you set up rules to automatically send emails to your users after they perform actions, making drip email campaigns really easy. Take your company's email analysis to the next level by **adding Customer.io as a Source to Segment.** Segment automatically collects email events like `Email Delivered` and `Email Opened`, forward them to your destinations, and load them into your data warehouse.  diff --git a/src/connections/sources/catalog/cloud-apps/delighted/index.md b/src/connections/sources/catalog/cloud-apps/delighted/index.md index 62b3511f59..17cf3c963f 100644 --- a/src/connections/sources/catalog/cloud-apps/delighted/index.md +++ b/src/connections/sources/catalog/cloud-apps/delighted/index.md @@ -2,6 +2,9 @@ title: Delighted Source rewrite: true --- + +{% include content/source-region-unsupported.md %} + [Delighted](https://delighted.com/) is the fastest and easiest way to gather actionable feedback from your customers. Use the feedback you gather from customers in all of your decision making processes. Send your feedback to your BI and data warehouses automatically. This source is maintained by Delighted. For any issues with the source, you may [contact the Delighted Support team](mailto:hello@delighted.com). diff --git a/src/connections/sources/catalog/cloud-apps/desk-com/index.md b/src/connections/sources/catalog/cloud-apps/desk-com/index.md index b4f5da4b8f..3575f53688 100644 --- a/src/connections/sources/catalog/cloud-apps/desk-com/index.md +++ b/src/connections/sources/catalog/cloud-apps/desk-com/index.md @@ -8,6 +8,7 @@ hidden: true > error "" > Desk.com ended operations on March 13th 2020. This page is for historical reference purposes only. +{% include content/source-region-unsupported.md %} [Desk.com](http://www.desk.com/), previously known as Assistly, is a SaaS help desk and customer support product owned by Salesforce.com and accessible through the cloud. diff --git a/src/connections/sources/catalog/cloud-apps/facebook-ads/index.md b/src/connections/sources/catalog/cloud-apps/facebook-ads/index.md index dbed063d4d..acd1b7beac 100644 --- a/src/connections/sources/catalog/cloud-apps/facebook-ads/index.md +++ b/src/connections/sources/catalog/cloud-apps/facebook-ads/index.md @@ -4,6 +4,8 @@ rewrite: true strat: facebook --- +{% include content/source-region-unsupported.md %} + Facebook is one of the most efficient ways to advertise online. Take your company's analysis to the next level by adding [Facebook Ads](https://www.facebook.com/business/products/ads) as a Source to Segment. ## Getting Started diff --git a/src/connections/sources/catalog/cloud-apps/facebook-lead-ads/index.md b/src/connections/sources/catalog/cloud-apps/facebook-lead-ads/index.md index 977cb29c07..ae80afb289 100644 --- a/src/connections/sources/catalog/cloud-apps/facebook-lead-ads/index.md +++ b/src/connections/sources/catalog/cloud-apps/facebook-lead-ads/index.md @@ -4,6 +4,8 @@ rewrite: true strat: facebook --- +{% include content/source-region-unsupported.md %} + Facebook Lead Ads help you capture contact information from people who have expressed interest in your product. Without leaving Facebook's interface, your prospects can now share helpful information with you including work email, name, phone number, and more. Learn more about Facebook Lead Ads [here](https://www.facebook.com/business/news/lead-ads-launch).  Segment lets you make the most of your leads by automatically sending them to your business tools like CRM and email. Importantly, these destinations allow you to contact customers in real-time using your communication platform of choice, whether you've promised them a demo, a newsletter, a piece of content, or a call from a salesperson. diff --git a/src/connections/sources/catalog/cloud-apps/factual-engine/index.md b/src/connections/sources/catalog/cloud-apps/factual-engine/index.md index 3f1387bb9e..2286c24cf8 100644 --- a/src/connections/sources/catalog/cloud-apps/factual-engine/index.md +++ b/src/connections/sources/catalog/cloud-apps/factual-engine/index.md @@ -4,6 +4,8 @@ beta: true source-type: event --- +{% include content/source-region-unsupported.md %} + ## How Engine Works Installing the Engine SDK in your app enables you to gather and analyze information about your users' location. Engine caches the relevant portion of Factual's Global Places data on the device to determine where the user is, beyond raw location. Engine needs device location data in order to work and will use whatever location permissions your app has authorized. You can also set custom rules to trigger "actions" like push notifications or emails. diff --git a/src/connections/sources/catalog/cloud-apps/foursquare-pilgrim/index.md b/src/connections/sources/catalog/cloud-apps/foursquare-pilgrim/index.md index 3efdf742b6..0c0022bc21 100644 --- a/src/connections/sources/catalog/cloud-apps/foursquare-pilgrim/index.md +++ b/src/connections/sources/catalog/cloud-apps/foursquare-pilgrim/index.md @@ -3,6 +3,8 @@ title: Foursquare Pilgrim beta: true --- +{% include content/source-region-unsupported.md %} + [Foursquare's Pilgrim SDK](https://developer.foursquare.com/pilgrimsdk) provides real-time event triggering based upon your users’ location in the physical world, allowing you to harness our powerful geotargeting capabilities to send those events to other services using Segment. This destination is maintained by Foursquare. For any issues with the destination, [contact the Foursquare Developer Support team](mailto:developers@foursquare.com). diff --git a/src/connections/sources/catalog/cloud-apps/friendbuy/index.md b/src/connections/sources/catalog/cloud-apps/friendbuy/index.md index 3dca4425ba..9e02881d6b 100644 --- a/src/connections/sources/catalog/cloud-apps/friendbuy/index.md +++ b/src/connections/sources/catalog/cloud-apps/friendbuy/index.md @@ -1,6 +1,9 @@ --- title: 'Friendbuy Source' --- + +{% include content/source-region-unsupported.md %} + Friendbuy is a referral marketing platform that powers modern day word of mouth. Designed for growth marketers, Friendbuy allows companies to acquire new customers at scale through seamlessly integrated referral and influencer campaigns. Adding Friendbuy as a Source to Segment is a surefire way to elevate analysis of your referral program performance. Friendbuy will automatically send referral events and important metadata to Segment. diff --git a/src/connections/sources/catalog/cloud-apps/google-ads/index.md b/src/connections/sources/catalog/cloud-apps/google-ads/index.md index 54aca810a4..28935c31f9 100644 --- a/src/connections/sources/catalog/cloud-apps/google-ads/index.md +++ b/src/connections/sources/catalog/cloud-apps/google-ads/index.md @@ -3,6 +3,8 @@ title: Google Ads Source rewrite: true --- +{% include content/source-region-unsupported.md %} + Google Ads is an online advertising service developed by Google. With Google Ads, you can take advantage of online advertising to improve your internet marketing effectiveness. [Visit Website](https://ads.google.com/home/) If you notice any gaps, outdated information or want to leave some feedback to help improve this documentation, please [contact Segment Support](https://segment.com/help/contact). diff --git a/src/connections/sources/catalog/cloud-apps/herow/index.md b/src/connections/sources/catalog/cloud-apps/herow/index.md index 1a5d33439b..ce47012e35 100644 --- a/src/connections/sources/catalog/cloud-apps/herow/index.md +++ b/src/connections/sources/catalog/cloud-apps/herow/index.md @@ -3,6 +3,8 @@ title: Herow beta: true --- +{% include content/source-region-unsupported.md %} + [HEROW](https://www.herow.io) is a contextual platform for mobile application. Built around everyday behaviors and powered by location intelligence, its one-stop solution allows apps to maximize mobile engagement with their users. This is an [Enrichment Source](https://segment.com/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but they can also federate the exported data into your other enabled Segment Destinations. diff --git a/src/connections/sources/catalog/cloud-apps/hubspot/index.md b/src/connections/sources/catalog/cloud-apps/hubspot/index.md index 6a663e114b..df3ef997fc 100644 --- a/src/connections/sources/catalog/cloud-apps/hubspot/index.md +++ b/src/connections/sources/catalog/cloud-apps/hubspot/index.md @@ -3,6 +3,8 @@ title: HubSpot Source rewrite: true --- +{% include content/source-region-unsupported.md %} + [HubSpot](http://www.hubspot.com) is an all-in-one marketing tool that helps attract new leads and convert them into paying customers, with features like landing page creation and email automation. Are you trying to set up HubSpot as a destination to receive data from Segment? Go here [HubSpot Destination](https://segment.com/docs/connections/destinations/catalog/hubspot/). diff --git a/src/connections/sources/catalog/cloud-apps/intercom/index.md b/src/connections/sources/catalog/cloud-apps/intercom/index.md index d194629111..e638400c20 100644 --- a/src/connections/sources/catalog/cloud-apps/intercom/index.md +++ b/src/connections/sources/catalog/cloud-apps/intercom/index.md @@ -3,6 +3,8 @@ title: Intercom Source rewrite: true --- +{% include content/source-region-unsupported.md %} + [Intercom](http://intercom.com) is a customer platform with a suite of products for live chat, marketing, feedback, and support. With Intercom you will be able to send targeted messages to the right people at the right time, manage conversations with leads and customers at scale and create, organize, and publish articles to help people get answers to their questions and get started with your app. Take your company's email analysis to the next level by **adding Intercom as a Source to Segment.** Segment automatically collects objects like `Users` and `Conversations` and load them into your data warehouse.  diff --git a/src/connections/sources/catalog/cloud-apps/iterable/index.md b/src/connections/sources/catalog/cloud-apps/iterable/index.md index f6dc402dcc..16ab545ead 100644 --- a/src/connections/sources/catalog/cloud-apps/iterable/index.md +++ b/src/connections/sources/catalog/cloud-apps/iterable/index.md @@ -1,6 +1,9 @@ --- title: 'Iterable Source' --- + +{% include content/source-region-unsupported.md %} + Iterable is the growth marketing platform that enables brands to create, execute and optimize campaigns to power world-class customer engagement across email, push, SMS, in-app and more with unparalleled data flexibility. An integrated, cross-channel solution—built for marketers, trusted by engineers, designed with intelligence. Take your company's marketing analysis to the next level by **adding Iterable as a Source to Segment**. Iterable will automatically collect cross-channel messaging events like `Email Delivered` and `Push Delivered`, forward them to your destinations and load them into your data warehouse. diff --git a/src/connections/sources/catalog/cloud-apps/klaviyo/index.md b/src/connections/sources/catalog/cloud-apps/klaviyo/index.md index 95e93a6e9d..d26d9e01c2 100644 --- a/src/connections/sources/catalog/cloud-apps/klaviyo/index.md +++ b/src/connections/sources/catalog/cloud-apps/klaviyo/index.md @@ -2,6 +2,8 @@ title: 'Klaviyo Source' --- +{% include content/source-region-unsupported.md %} + Klaviyo is an email marketing platform that helps companies make more money. It lets you send personalized newsletters, triggered emails, product recommendations, push notifications and sync your data to facebook custom audiences. [Visit Website](https://www.klaviyo.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) Take your company's email analysis to the next level by **adding Klaviyo as a Source to Segment.** Segment automatically collects email events like `Email Delivered` and `Email Opened`, forward them to your destinations, and load them into your data warehouse.  diff --git a/src/connections/sources/catalog/cloud-apps/klenty/index.md b/src/connections/sources/catalog/cloud-apps/klenty/index.md index 56cbf0d730..112bed4b00 100644 --- a/src/connections/sources/catalog/cloud-apps/klenty/index.md +++ b/src/connections/sources/catalog/cloud-apps/klenty/index.md @@ -1,6 +1,9 @@ --- title: Klenty Source --- + +{% include content/source-region-unsupported.md %} + [Klenty](https://www.klenty.com/) helps sales teams to send personalized emails and automated follow-ups at scale. With Klenty, your sales team can completely automate their email outreach and focus on closing more deals. This source is maintained by Klenty. For any issues with the destination, [contact the Klenty Support team](mailto:support@klenty.com). diff --git a/src/connections/sources/catalog/cloud-apps/launchdarkly/index.md b/src/connections/sources/catalog/cloud-apps/launchdarkly/index.md index 2fec5909ba..02ddd06fa9 100644 --- a/src/connections/sources/catalog/cloud-apps/launchdarkly/index.md +++ b/src/connections/sources/catalog/cloud-apps/launchdarkly/index.md @@ -1,6 +1,9 @@ --- title: LaunchDarkly Source --- + +{% include content/source-region-unsupported.md %} + [LaunchDarkly](https://launchdarkly.com) is a feature management platform that empowers development teams to safely deliver and control software through feature flags. This source is maintained by LaunchDarkly. For any issues with the source, [contact the LaunchDarkly Support team](mailto:support@launchdarkly.com). diff --git a/src/connections/sources/catalog/cloud-apps/leanplum/index.md b/src/connections/sources/catalog/cloud-apps/leanplum/index.md index 2f0e49048d..0f92293259 100644 --- a/src/connections/sources/catalog/cloud-apps/leanplum/index.md +++ b/src/connections/sources/catalog/cloud-apps/leanplum/index.md @@ -4,6 +4,8 @@ beta: true source-type: event --- +{% include content/source-region-unsupported.md %} + [Leanplum](https://leanplum.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a multi-channel customer engagement platform that helps Growth and Marketing teams to achieve their engagement and revenue goals. When you add Leanplum as a Source, Segment starts collecting Leanplum engagement events (for example, Email Open, Push Delivered), which you can then connect to a destination of your choice or load in your data warehouse. diff --git a/src/connections/sources/catalog/cloud-apps/looker/index.md b/src/connections/sources/catalog/cloud-apps/looker/index.md index d21a307105..82caeb6570 100644 --- a/src/connections/sources/catalog/cloud-apps/looker/index.md +++ b/src/connections/sources/catalog/cloud-apps/looker/index.md @@ -1,6 +1,9 @@ --- title: Looker Source --- + +{% include content/source-region-unsupported.md %} + Looker is a business intelligence software platform that helps you explore, analyze and share real-time business insights easily. Create custom cohorts of customers in Looker's powerful and flexible exploration tool and pass your analysis into your marketing tools for activation and engagement using the Looker Source in Segment. ## Getting Started diff --git a/src/connections/sources/catalog/cloud-apps/mailchimp/index.md b/src/connections/sources/catalog/cloud-apps/mailchimp/index.md index 64ef01ad49..58f79c94f3 100644 --- a/src/connections/sources/catalog/cloud-apps/mailchimp/index.md +++ b/src/connections/sources/catalog/cloud-apps/mailchimp/index.md @@ -2,6 +2,8 @@ title: Mailchimp Source --- +{% include content/source-region-unsupported.md %} + ## Getting Started 1. From your workspace's `/sources` page, click `add source`. diff --git a/src/connections/sources/catalog/cloud-apps/mailjet/index.md b/src/connections/sources/catalog/cloud-apps/mailjet/index.md index 6ed79e17ce..f24cfafbfc 100644 --- a/src/connections/sources/catalog/cloud-apps/mailjet/index.md +++ b/src/connections/sources/catalog/cloud-apps/mailjet/index.md @@ -1,6 +1,9 @@ --- title: 'Mailjet Source' --- + +{% include content/source-region-unsupported.md %} + Mailjet is a powerful email service provider that enables you to send, deliver and track transactional and marketing emails all from one single account. With Mailjet, Marketers and Developers can send and track emails using API, User Interface or SMTP Relay. Take your company's email analysis to the next level by **adding Mailjet as a Source to Segment.** Segment automatically collects email events like `Email Delivered` and `Email Opened`, forward them to your destinations, and load them into your data warehouse.  diff --git a/src/connections/sources/catalog/cloud-apps/mandrill/index.md b/src/connections/sources/catalog/cloud-apps/mandrill/index.md index 30b67ea113..317a81758f 100644 --- a/src/connections/sources/catalog/cloud-apps/mandrill/index.md +++ b/src/connections/sources/catalog/cloud-apps/mandrill/index.md @@ -2,6 +2,8 @@ title: Mandrill Source --- +{% include content/source-region-unsupported.md %} + [Mandrill](http://www.mandrill.com/) is a transactional email API for MailChimp users. Take your company's email analysis to the next level by **adding Mandrill as a Source to Segment.** Segment automatically collects email events like `Sent` and `Opened` and load them into your data warehouse.  diff --git a/src/connections/sources/catalog/cloud-apps/marketo/index.md b/src/connections/sources/catalog/cloud-apps/marketo/index.md index 9c3a68059f..50d2322222 100644 --- a/src/connections/sources/catalog/cloud-apps/marketo/index.md +++ b/src/connections/sources/catalog/cloud-apps/marketo/index.md @@ -6,6 +6,8 @@ strat: adobe --- +{% include content/source-region-unsupported.md %} + [Marketo](https://www.marketo.com/) is a leader in marketing automation. Using our Marketo source, we will load your campaigns, emails, leads and other collections into your data warehouse. This will allow you to write SQL to analyze your analyze your email marketing campaigns ROI, or join your email data to other data sources like web and mobile events, Salesforce, and Zendesk to tie nurture emails to re-activation rates in your app. diff --git a/src/connections/sources/catalog/cloud-apps/mixpanel-cohorts-source/index.md b/src/connections/sources/catalog/cloud-apps/mixpanel-cohorts-source/index.md index d471801355..79587ce261 100644 --- a/src/connections/sources/catalog/cloud-apps/mixpanel-cohorts-source/index.md +++ b/src/connections/sources/catalog/cloud-apps/mixpanel-cohorts-source/index.md @@ -1,4 +1,6 @@ --- title: Mixpanel Cohorts Source hidden: true ---- \ No newline at end of file +--- + +{% include content/source-region-unsupported.md %} diff --git a/src/connections/sources/catalog/cloud-apps/mixpanel-cohorts/index.md b/src/connections/sources/catalog/cloud-apps/mixpanel-cohorts/index.md index d725d098ea..f9a9033083 100644 --- a/src/connections/sources/catalog/cloud-apps/mixpanel-cohorts/index.md +++ b/src/connections/sources/catalog/cloud-apps/mixpanel-cohorts/index.md @@ -4,6 +4,7 @@ redirect_from: - '/connections/sources/catalog/cloud-apps/mixpanel-cohorts-source/' --- +{% include content/source-region-unsupported.md %} [Mixpanel Cohorts](https://help.mixpanel.com/hc/en-us/articles/115005708186-Cohorts-Overview-){:target="_blank} are groups of users defined by a set of criteria. The Mixpanel Cohorts Source allows you to export Cohorts of users from Mixpanel to Segment so that you can better target users across many downstream connections. You can sync Cohorts of users to your Segment-connected raw data warehouses and downstream destinations that accept Segment identify events. diff --git a/src/connections/sources/catalog/cloud-apps/moesif-api-analytics/index.md b/src/connections/sources/catalog/cloud-apps/moesif-api-analytics/index.md index 5b77bcb571..f999e8568f 100644 --- a/src/connections/sources/catalog/cloud-apps/moesif-api-analytics/index.md +++ b/src/connections/sources/catalog/cloud-apps/moesif-api-analytics/index.md @@ -1,6 +1,9 @@ --- title: Moesif API Analytics Source --- + +{% include content/source-region-unsupported.md %} + [Moesif API Analytics](https://www.moesif.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) helps you drive API adoption, usage, and retention. With Moesif, track your customer journey from initial ad click to first API call while identifying at-risk customers struggling to integrate with your APIs. The [Moesif SDKs and API gateway plugins](https://www.moesif.com/implementation?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) are open-source and support REST, GraphQL, and other APIs. diff --git a/src/connections/sources/catalog/cloud-apps/nudgespot/index.md b/src/connections/sources/catalog/cloud-apps/nudgespot/index.md index bda1ada7af..f8d02360b4 100644 --- a/src/connections/sources/catalog/cloud-apps/nudgespot/index.md +++ b/src/connections/sources/catalog/cloud-apps/nudgespot/index.md @@ -1,6 +1,9 @@ --- title: 'Nudgespot Source' --- + +{% include content/source-region-unsupported.md %} + Nudgespot is the easiest way to trigger emails, SMS, push notifications or in-app messages to your customers, at the right time. [Visit Website](http://www.nudgespot.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) Take your company's email analysis to the next level by **adding Nudgespot as a Source to Segment.** Segment automatically collects email events like `Email Delivered` and `Email Opened`, forward them to your destinations, and load them into your data warehouse.  diff --git a/src/connections/sources/catalog/cloud-apps/pendo/index.md b/src/connections/sources/catalog/cloud-apps/pendo/index.md index b7655eae48..67c51aca43 100644 --- a/src/connections/sources/catalog/cloud-apps/pendo/index.md +++ b/src/connections/sources/catalog/cloud-apps/pendo/index.md @@ -1,6 +1,9 @@ --- title: Pendo Source --- + +{% include content/source-region-unsupported.md %} + [Pendo](https://pendo.io) is a product cloud that helps product teams deliver software users love. With Pendo, product teams can understand product usage, collect feedback, measure NPS, onboard users, and announce new features in app—all without requiring engineering resources. This source is maintained by Pendo. For any issues with the source, [contact the Pendo Support team](mailto:integrations@pendo.io). diff --git a/src/connections/sources/catalog/cloud-apps/provesource/index.md b/src/connections/sources/catalog/cloud-apps/provesource/index.md index 19ccbb9d57..573ee5a9ed 100644 --- a/src/connections/sources/catalog/cloud-apps/provesource/index.md +++ b/src/connections/sources/catalog/cloud-apps/provesource/index.md @@ -1,6 +1,9 @@ --- title: ProveSource Source --- + +{% include content/source-region-unsupported.md %} + [ProveSource](https://provesrc.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a social proof platform, that lets you show recent activities and reviews that happen on your website - signups, purchases, positive reviews and more, this helps build trust with your visitors and ultimately increases your conversions rates. This source is maintained by ProveSource. For any issues with the source, [contact the ProveSouce Support team](mailto:support@provesrc.com). diff --git a/src/connections/sources/catalog/cloud-apps/radar/index.md b/src/connections/sources/catalog/cloud-apps/radar/index.md index 5b0c4d38e0..96561777b0 100644 --- a/src/connections/sources/catalog/cloud-apps/radar/index.md +++ b/src/connections/sources/catalog/cloud-apps/radar/index.md @@ -2,6 +2,8 @@ title: Radar Source --- +{% include content/source-region-unsupported.md %} + [Radar](https://radar.com) is the leading geofencing and location tracking platform. You can use Radar SDKs and APIs to build a wide range of location-based product and service experiences, including pickup and delivery tracking, location-triggered notifications, location verification, store locators, address autocomplete, and more. The Radar Segment Source is a Cloud-mode event source. Instead of packaging Radar's SDK using Segment as a wrapper, you include, configure, and initialize their SDK separately. Radar then sends all events that it detects and infers to Segment using its servers. As a result, only destinations that allow Cloud-mode are compatible with the Radar source. diff --git a/src/connections/sources/catalog/cloud-apps/refiner/index.md b/src/connections/sources/catalog/cloud-apps/refiner/index.md index 344547df5f..49f009bec1 100644 --- a/src/connections/sources/catalog/cloud-apps/refiner/index.md +++ b/src/connections/sources/catalog/cloud-apps/refiner/index.md @@ -3,6 +3,8 @@ title: Refiner Source source-type: event --- +{% include content/source-region-unsupported.md %} + [Refiner](https://refiner.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a customer survey tool built specifically for SaaS, eCommerce and Membership sites. Ask your users any question while they are using your product with Refiner's beautiful and simple survey widgets - on brand and perfectly timed. This source allows you to enrich user profiles with survey responses and use them in any tool connected to your Segment account. diff --git a/src/connections/sources/catalog/cloud-apps/regal-voice/index.md b/src/connections/sources/catalog/cloud-apps/regal-voice/index.md index 427eefb8fe..2e9c2469ef 100644 --- a/src/connections/sources/catalog/cloud-apps/regal-voice/index.md +++ b/src/connections/sources/catalog/cloud-apps/regal-voice/index.md @@ -3,6 +3,8 @@ title: Regal Voice Source source-type: event --- +{% include content/source-region-unsupported.md %} + [Regal Voice](https://regalvoice.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a next-gen customer engagement platform built for B2C services brands to proactively reach out to customers on voice and sms before they buy elsewhere. This source is maintained by Regal Voice. For any issues with the source, [contact the Regal Voice Support team](mailto:support@regalvoice.com). diff --git a/src/connections/sources/catalog/cloud-apps/salesforce-marketing-cloud/index.md b/src/connections/sources/catalog/cloud-apps/salesforce-marketing-cloud/index.md index 16e7da5cf0..0e530d368a 100644 --- a/src/connections/sources/catalog/cloud-apps/salesforce-marketing-cloud/index.md +++ b/src/connections/sources/catalog/cloud-apps/salesforce-marketing-cloud/index.md @@ -6,6 +6,8 @@ strat: salesforce --- +{% include content/source-region-unsupported.md %} + [Salesforce Marketing Cloud](https://www.salesforce.com/ca/products/marketing-cloud/overview/), formerly known as ExactTarget, is a marketing automation suite with the ability to build complete customer journeys as well as creating, targeting, tracking, and managing email and digital media campaigns. diff --git a/src/connections/sources/catalog/cloud-apps/salesforce/index.md b/src/connections/sources/catalog/cloud-apps/salesforce/index.md index adfbac3969..48267071f5 100644 --- a/src/connections/sources/catalog/cloud-apps/salesforce/index.md +++ b/src/connections/sources/catalog/cloud-apps/salesforce/index.md @@ -2,6 +2,9 @@ title: Salesforce Source strat: salesforce --- + +{% include content/source-region-unsupported.md %} + [Salesforce](http://salesforce.com){:target="_blank"} is a leader in on-demand customer relationship management. Take your company's analysis to the next level by **adding Salesforce as a Source to Segment.** Segment automatically collects objects like `Accounts`, `Campaigns`, and `Tasks` and loads them into your data warehouse.  diff --git a/src/connections/sources/catalog/cloud-apps/selligent-marketing-cloud/index.md b/src/connections/sources/catalog/cloud-apps/selligent-marketing-cloud/index.md index 5e3815b9bc..bb892f4157 100644 --- a/src/connections/sources/catalog/cloud-apps/selligent-marketing-cloud/index.md +++ b/src/connections/sources/catalog/cloud-apps/selligent-marketing-cloud/index.md @@ -2,6 +2,9 @@ title: Selligent Marketing Cloud Source source-type: event --- + +{% include content/source-region-unsupported.md %} + [Selligent Marketing Cloud](https://selligent.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is a highly integrated, AI-powered omnichannel marketing automation platform which enables ambitious B2C marketers to maximize every moment of interaction with today’s connected consumers. Deliver ultra-personalized, highly relevant customer experiences across channels and devices, providing value swiftly and at scale. This source is maintained by Selligent Marketing Cloud. For any issues with the source, [contact the Selligent Marketing Cloud Support team](mailto:scrum-redwood@selligent.com). diff --git a/src/connections/sources/catalog/cloud-apps/selligent/index.md b/src/connections/sources/catalog/cloud-apps/selligent/index.md index 58cf710022..7367194741 100644 --- a/src/connections/sources/catalog/cloud-apps/selligent/index.md +++ b/src/connections/sources/catalog/cloud-apps/selligent/index.md @@ -4,6 +4,9 @@ source-type: event hidden: true --- + +{% include content/source-region-unsupported.md %} + Selligent is a cross-channel marketing platform that allows brands to effectively engage with their customers across email, mobile, social, display and web channels. Take your company's email analysis to the next level by **adding Selligent as a Source to Segment.** Segment automatically collects email events like `Email Delivered` and `Email Opened`, forward them to your destinations, and load them into your data warehouse. diff --git a/src/connections/sources/catalog/cloud-apps/sendgrid/index.md b/src/connections/sources/catalog/cloud-apps/sendgrid/index.md index 2988b27810..87dba41fdd 100644 --- a/src/connections/sources/catalog/cloud-apps/sendgrid/index.md +++ b/src/connections/sources/catalog/cloud-apps/sendgrid/index.md @@ -1,6 +1,9 @@ --- title: Sendgrid Source --- + +{% include content/source-region-unsupported.md %} + SendGrid is a trusted platform for transactional email and email marketing. [Visit Website](http://sendgrid.com) Take your company's analysis to the next level by **adding Sendgrid as a Source to Segment.** Segment automatically collects events like `Click` or `Delivered` and objects such as `Recipients` or `Campaigns` and load them into your data warehouse.  diff --git a/src/connections/sources/catalog/cloud-apps/shopify-littledata/index.md b/src/connections/sources/catalog/cloud-apps/shopify-littledata/index.md index afdf7260be..e0bbfc2273 100644 --- a/src/connections/sources/catalog/cloud-apps/shopify-littledata/index.md +++ b/src/connections/sources/catalog/cloud-apps/shopify-littledata/index.md @@ -4,6 +4,8 @@ source-type: event published: false --- +{% include content/source-region-unsupported.md %} + Littledata is a smart analytics app that automates ecommerce tracking. Littledata's [Shopify-to-Segment connection](https://www.littledata.io/connections/segment/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) automatically tracks key ecommerce events on a Shopify or Shopify Plus store, so you can use Shopify as a source in your Segment workspace. Littledata uses a smart tracking script that can be applied to any Shopify site. The app uses server-side tracking to ensure 100% accuracy, gathering data at every customer touch point. diff --git a/src/connections/sources/catalog/cloud-apps/stripe/index.md b/src/connections/sources/catalog/cloud-apps/stripe/index.md index 404dd9f95d..279d095077 100644 --- a/src/connections/sources/catalog/cloud-apps/stripe/index.md +++ b/src/connections/sources/catalog/cloud-apps/stripe/index.md @@ -2,6 +2,9 @@ title: Stripe Source rewrite: true --- + +{% include content/source-region-unsupported.md %} + [Stripe](https://stripe.com/about) builds economic infrastructure for the internet, that enables businesses of every size to accept payments and manage their businesses online. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, [let us know](https://segment.com/help/contact)! diff --git a/src/connections/sources/catalog/cloud-apps/twilio-event-streams-beta/index.md b/src/connections/sources/catalog/cloud-apps/twilio-event-streams-beta/index.md index cdf52d2080..4ed8d61a2c 100644 --- a/src/connections/sources/catalog/cloud-apps/twilio-event-streams-beta/index.md +++ b/src/connections/sources/catalog/cloud-apps/twilio-event-streams-beta/index.md @@ -1,4 +1,6 @@ --- title: Twilio Event Streams (Beta) hidden: true ---- \ No newline at end of file +--- + +{% include content/source-region-unsupported.md %} diff --git a/src/connections/sources/catalog/cloud-apps/twilio/index.md b/src/connections/sources/catalog/cloud-apps/twilio/index.md index b49f193242..d819601178 100644 --- a/src/connections/sources/catalog/cloud-apps/twilio/index.md +++ b/src/connections/sources/catalog/cloud-apps/twilio/index.md @@ -2,6 +2,9 @@ title: Twilio Source rewrite: true --- + +{% include content/source-region-unsupported.md %} + [Twilio](http://twilio.com) is a developer platform for communications. Software teams use Twilio APIs to add capabilities like voice, video, and messaging to their applications. This enables businesses to provide the right communications experience for their customers. Behind Twilio APIs is a Super Network, a software layer that connects and optimizes communications networks around the world. This is what allows users to reliably call and message anyone anywhere. ## Getting Started diff --git a/src/connections/sources/catalog/cloud-apps/vero/index.md b/src/connections/sources/catalog/cloud-apps/vero/index.md index c58d23099f..23434f5ae9 100644 --- a/src/connections/sources/catalog/cloud-apps/vero/index.md +++ b/src/connections/sources/catalog/cloud-apps/vero/index.md @@ -1,6 +1,9 @@ --- title: 'Vero Source' --- + +{% include content/source-region-unsupported.md %} + Vero is an email marketing tool that lets you set up automated emails to your users that get sent after they've completed certain actions. [Visit Website](http://getvero.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) Take your company's email analysis to the next level by **adding Vero as a Source to Segment.** Segment automatically collects email events like `Email Delivered` and `Email Opened`, forward them to your destinations, and load them into your data warehouse.  diff --git a/src/connections/sources/catalog/cloud-apps/wootric/index.md b/src/connections/sources/catalog/cloud-apps/wootric/index.md index a16fe44b46..243cf4e1f1 100644 --- a/src/connections/sources/catalog/cloud-apps/wootric/index.md +++ b/src/connections/sources/catalog/cloud-apps/wootric/index.md @@ -5,6 +5,8 @@ redirect_from: - 'connections/sources/catalog/cloud-apps/inmoment-formerly-wootric' --- +{% include content/source-region-unsupported.md %} + [InMoment](https://wootric.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) (formerly Wootric) is modern customer feedback management software. You can incorporate Voice of Customer data in your decision-making processes and marketing campaigns, and trigger customer follow-up when you send survey responses to your CRM, marketing platform or data warehouses automatically. InMoment maintains this source. For any issues, [contact the InMoment support team](mailto:support@wootric.com). diff --git a/src/connections/sources/catalog/cloud-apps/youbora/index.md b/src/connections/sources/catalog/cloud-apps/youbora/index.md index 22b1c5661c..04eed1f231 100644 --- a/src/connections/sources/catalog/cloud-apps/youbora/index.md +++ b/src/connections/sources/catalog/cloud-apps/youbora/index.md @@ -4,6 +4,8 @@ beta: true hidden: true --- +{% include content/source-region-unsupported.md %} + YOUBORA is the most advanced and holistic suite of integrated video analytics and business intelligence for broadcasters, OTTs, telcos and media companies to help you make data-driven, business, operational and technical decisions to drive performance and maximize revenue across your entire video service. The latest version of YOUBORA has been thought through from the ground up to deliver the most detailed intelligence for your service. This source is maintained by YOUBORA. For any issues with the source, [contact the YOUBORA Support team](https://nicepeopleatwork.com/contactus). diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index 99ceb5ecfc..b73ef03c02 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -2,6 +2,8 @@ title: Zendesk Source --- +{% include content/source-region-unsupported.md %} + [Zendesk](https://www.zendesk.com/) is a customer service platform for enterprises, which provides a customer support platform that allows quicker and easier interaction between businesses and customers. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, [let us know](https://segment.com/help/contact)! diff --git a/src/connections/sources/catalog/libraries/website/javascript/upgrade-to-ajs2.md b/src/connections/sources/catalog/libraries/website/javascript/upgrade-to-ajs2.md index d59b1dd0eb..7d27ff659c 100644 --- a/src/connections/sources/catalog/libraries/website/javascript/upgrade-to-ajs2.md +++ b/src/connections/sources/catalog/libraries/website/javascript/upgrade-to-ajs2.md @@ -50,7 +50,7 @@ If the source you intend to upgrade uses the in-domain instrumentation as well a ### Relying on Analytics.js Classic's `ajs_anonymous_id` cookie format -Analytics.js 2.0 removes inbuilt quotes from cookie values, resulting in a different format for the `ajs_anonymous_id` value when compared to Analytics.js Classic. Though you can retrieve cookie values with [standard supported functions](/docs/connections/sources/catalog/libraries/website/javascript/identity/#retrieve-the-anonymous-id), you'll need to configure your environment to accept the new format if your implementation relies on accessing the cookie value directly. +Analytics.js 2.0 removes inbuilt quotes from cookie values, resulting in a different format for the `ajs_anonymous_id` value when compared to Analytics.js Classic. Though you can retrieve cookie values with [standard supported functions](/docs/connections/sources/catalog/libraries/website/javascript/identity/#retrieve-the-anonymous-id), you'll need to configure your environment to accept the new format using the `utility` [plugin](/docs/connections/sources/catalog/libraries/website/javascript/index/#example-plugins) if your implementation relies on accessing the cookie value directly. ### Using a strict content security policy on the page From ccedea404a7949e9c9bdab331d9797cc7ebcdcca Mon Sep 17 00:00:00 2001 From: markzegarelli Date: Tue, 1 Feb 2022 15:09:28 -0800 Subject: [PATCH 2/4] Friendbuy Actions destinations (#2445) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Adding admonition infrastructure * DOC-393 Taking it out of an admonition format and adding it to the paragraph above it * [DOC-393] Simplifying the information, adding it to the sentence before it * Fixes to Contributing page * small update to ga4 * Update CONTRIBUTING.md Frontmatter -> Front matter * Add note about Criteo connection modes with Analytics.js (#2437) * Add clarity to HubSpot API limit (#2436) * Update CONTRIBUTING.md * catalog update * Add Troubleshooting section to GEC docs (#2434) * add Troubleshooting section to GEC docs * style edits Co-authored-by: markzegarelli * redirect sprig actions (#2423) * remove connection table * Linking to FQL from Destination Filters doc (#2421) * Linking to FQL from Destination Filters doc * Update src/connections/destinations/destination-filters.md Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> * [byteplus] adding new destination folder in order to show new name in… (#2414) * [byteplus] adding new destination folder in order to show new name in docs URL * local links should be relative Co-authored-by: markzegarelli * Add region unsupported message for all cloud sources (#2422) * Add region unsupported message for all cloud sources * Remove spaces * prettify markdown * copy edits Co-authored-by: markzegarelli * Friendbuy cloud destination (#2416) * Apply Friendbuy web destination documentation rename from master branch. * Copy Friendbuy web destination documentation as basis for cloud destination. * Update to Friendbuy web destination documentation. * Documentation for new Friendbuy cloud destination. * Apply suggestions from code review Co-authored-by: rchinn-segment <93161299+rchinn-segment@users.noreply.github.com> * Minor language tweaks. * Changed "might" to "probably" because it's unlikely that someone using both Friendbuy and Segment wouldn't use the Friendbuy web destination. * Changed "won't load" to "won't be loaded" because whether our JavaScript is loaded or not is outside of its control. Segment does not call the web destination's initialization function unless at least one mapping is enabled. * Move the Friendbuy web destination documentation back to actions-friendbuy. Co-authored-by: rchinn-segment <93161299+rchinn-segment@users.noreply.github.com> * update catalog Co-authored-by: forstisabella <92472883+forstisabella@users.noreply.github.com> Co-authored-by: pwseg Co-authored-by: Segment Docs Robot <73141528+bot-docsteam@users.noreply.github.com> Co-authored-by: kdaswani <49517136+kdaswani@users.noreply.github.com> Co-authored-by: rchinn-segment <93161299+rchinn-segment@users.noreply.github.com> Co-authored-by: pwseg <86626706+pwseg@users.noreply.github.com> Co-authored-by: Niall Brennan Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> Co-authored-by: Thomas Gilbert <64277654+tcgilbert@users.noreply.github.com> Co-authored-by: jinapark202 <87985289+jinapark202@users.noreply.github.com> Co-authored-by: David Hull --- scripts/catalog_papi.js | 5 +- src/_data/catalog/destinations.yml | 2265 ++++++++++++++++- src/_data/catalog/regional-supported.yml | 12 + .../catalog/actions-friendbuy-cloud/index.md | 126 + .../catalog/actions-friendbuy/index.md | 21 +- .../catalog/friendbuy-actions/index.md | 5 + .../friendbuy-cloud-destination/index.md | 5 + 7 files changed, 2428 insertions(+), 11 deletions(-) create mode 100644 src/connections/destinations/catalog/actions-friendbuy-cloud/index.md create mode 100644 src/connections/destinations/catalog/friendbuy-actions/index.md create mode 100644 src/connections/destinations/catalog/friendbuy-cloud-destination/index.md diff --git a/scripts/catalog_papi.js b/scripts/catalog_papi.js index 4201b22dab..dcf0fab524 100644 --- a/scripts/catalog_papi.js +++ b/scripts/catalog_papi.js @@ -330,7 +330,7 @@ const updateDestinations = async () => { let regional = ['us-west'] // We need to be able to keep the system slug in some cases. - const slugOverrides = ['actions-google-enhanced-conversions', 'actions-google-analytics-4', 'actions-facebook-conversions-api'] + const slugOverrides = ['actions-google-enhanced-conversions', 'actions-google-analytics-4', 'actions-facebook-conversions-api', 'actions-friendbuy-cloud'] let slug = slugify(destination.name) if (slugOverrides.includes(destination.slug)) { slug = destination.slug @@ -341,7 +341,8 @@ const updateDestinations = async () => { const actionsDests = [ 'amplitude-actions', 'slack-actions', - 'fullstory-actions' + 'fullstory-actions', + 'friendbuy-actions' ] if (actionsDests.includes(slug)) { diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index 27bb310294..9df51bda42 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -7411,7 +7411,7 @@ items: display_name: BytePlus name: BytePlus slug: byteplus - hidden: true + hidden: false regional: - us-west url: connections/destinations/catalog/byteplus @@ -14049,6 +14049,2269 @@ items: label: Page Widgets actions: [] presets: [] +- destination_id: 6170a348128093cd0245e0ea + display_name: Friendbuy (Actions) + name: Friendbuy (Actions) + slug: actions-friendbuy + hidden: false + regional: + - us-west + url: connections/destinations/catalog/actions-friendbuy + previous_names: + - Friendbuy (Actions) + website: http://www.friendbuy.com + status: PUBLIC + categories: + - Referrals + logo: + url: https://cdn.filepicker.io/api/file/0OV3XmHVQi3n8PrFREPQ + mark: + url: https://cdn.filepicker.io/api/file/3BbFIi2bSsi08ig1RYgQ + methods: + track: true + identify: true + group: true + alias: true + page: true + platforms: + browser: true + mobile: false + server: false + components: [] + browserUnbundlingSupported: false + browserUnbundlingPublic: false + replay: false + connection_modes: + device: + web: false + mobile: false + server: false + cloud: + web: false + mobile: false + server: false + settings: + - name: merchantId + type: string + defaultValue: '' + description: >- + Find your Friendbuy Merchant ID by logging in to your [Friendbuy + account](https://retailer.friendbuy.io/) and going to Developer Center > + Friendbuy Code. + required: true + label: Friendbuy Merchant ID + actions: + - id: fk2xKEXiXd9qEkQb24nzXh + name: Track Page + slug: trackPage + description: >- + Record when a customer visits a new page. Allow Friendbuy widget targeting + by Page Name instead of URL. + platform: WEB + hidden: false + defaultTrigger: type = "page" + fields: + - id: e49CUAczWNodafjNEkGVLa + sortOrder: 0 + fieldKey: name + label: Page Name + type: STRING + description: The page name. + placeholder: '' + defaultValue: + '@path': $.name + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: neQAzqaMjCLWQ1QAt82tDb + sortOrder: 1 + fieldKey: category + label: Page Category + type: STRING + description: The page category. + placeholder: '' + defaultValue: + '@path': $.category + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 49oECrHAo9dQiUp2cMY5cw + sortOrder: 2 + fieldKey: title + label: Page Title + type: STRING + description: The page title. + placeholder: '' + defaultValue: + '@path': $.properties.title + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: jK3iMvwwXbgAz1EBm9Akq6 + name: Track Custom Event + slug: trackCustomEvent + description: Record when a customer completes any custom event that you define. + platform: WEB + hidden: false + defaultTrigger: null + fields: + - id: shTHGLkieU1eHuJcSdeLRB + sortOrder: 0 + fieldKey: eventType + label: Event Type + type: STRING + description: The type of the event to track. + placeholder: '' + defaultValue: + '@path': $.event + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 98zxb1CV5o2ke9JngvWEqY + sortOrder: 1 + fieldKey: eventProperties + label: Event Properties + type: OBJECT + description: >- + Object containing the properties for the event being tracked. All of the + fields in this object will be sent in the root of the Friendbuy track + event. + placeholder: '' + defaultValue: + '@path': $.properties + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 43bqAQttGP3YDk6Apnn2Ht + sortOrder: 2 + fieldKey: deduplicationId + label: Event ID + type: STRING + description: >- + An identifier for the event being tracked to prevent the same event from + being rewarded more than once. + placeholder: '' + defaultValue: + '@path': $.properties.deduplicationId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: bh1Tzs9mGXTvuDGNC6hYHB + sortOrder: 3 + fieldKey: customerId + label: Customer ID + type: STRING + description: The user's customer ID. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.properties.customerId + then: + '@path': $.properties.customerId + else: + '@path': $.userId + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: nk3aufvDqae12iG2gwC6VP + sortOrder: 4 + fieldKey: anonymousId + label: Anonymous ID + type: STRING + description: The user's anonymous id + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: vmZWyCzHXzKA4jxaHU5hwr + sortOrder: 5 + fieldKey: email + label: Email + type: STRING + description: The user's email address. + placeholder: '' + defaultValue: + '@path': $.properties.email + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: otSYqZFafJi5aae1yTwynq + name: Track Sign Up + slug: trackSignUp + description: Record when a customer signs up for a service. + platform: WEB + hidden: false + defaultTrigger: event = "Signed Up" + fields: + - id: 2gjjqzPLDWN9KLXbM3vu9F + sortOrder: 0 + fieldKey: customerId + label: Customer ID + type: STRING + description: The user's customer ID. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.properties.customerId + then: + '@path': $.properties.customerId + else: + '@path': $.userId + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: di1f8nNefQ7nVLdzBPfqAQ + sortOrder: 1 + fieldKey: anonymousId + label: Anonymous ID + type: STRING + description: The user's anonymous ID. + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 6MU84EwciUiTufPf97csEs + sortOrder: 2 + fieldKey: email + label: Email + type: STRING + description: The user's email address. + placeholder: '' + defaultValue: + '@path': $.properties.email + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 64C5Xdb6PxU4D9pEav5QDU + sortOrder: 3 + fieldKey: isNewCustomer + label: New Customer Flag + type: BOOLEAN + description: Flag to indicate whether the user is a new customer. + placeholder: '' + defaultValue: + '@path': $.properties.isNewCustomer + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: uNAEn545vDrLmwEdGtKKzK + sortOrder: 4 + fieldKey: loyaltyStatus + label: Loyalty Program Status + type: STRING + description: >- + The status of the user in your loyalty program. Valid values are "in", + "out", or "blocked". + placeholder: '' + defaultValue: + '@path': $.properties.loyaltyStatus + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: kbmgdNcJwLGhfu1x5JDyNy + sortOrder: 5 + fieldKey: firstName + label: First Name + type: STRING + description: The user's given name. + placeholder: '' + defaultValue: + '@path': $.properties.firstName + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: d8M4Wav1wd1kEgr5nz3djv + sortOrder: 6 + fieldKey: lastName + label: Last Name + type: STRING + description: The user's surname. + placeholder: '' + defaultValue: + '@path': $.properties.lastName + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: kiNVPyiWJao7H7i2d5vd3P + sortOrder: 7 + fieldKey: name + label: Name + type: STRING + description: The user's full name. + placeholder: '' + defaultValue: + '@path': $.properties.name + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: jAsUxchPn4dLrtJessdjvP + sortOrder: 8 + fieldKey: age + label: Age + type: NUMBER + description: The user's age. + placeholder: '' + defaultValue: + '@path': $.properties.age + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: bBwvh1FU6hTx7sZAv9Z4SY + sortOrder: 9 + fieldKey: birthday + label: Birthday + type: STRING + description: >- + The user's birthday in the format "YYYY-MM-DD", or "0000-MM-DD" to omit + the year. + placeholder: '' + defaultValue: + '@path': $.properties.birthday + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 4PjMfC53zf7q4Dweg3n8jQ + sortOrder: 10 + fieldKey: coupon + label: Coupon Code + type: STRING + description: Coupon code that customer supplied when they signed up. + placeholder: '' + defaultValue: + '@path': $.properties.coupon + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: kvzmQoZeSmWcBsZBDcVdqH + sortOrder: 11 + fieldKey: attributionId + label: Friendbuy Attribution ID + type: STRING + description: >- + Friendbuy attribution ID that associates the customer who is signing up + with the advocate who referred them. + placeholder: '' + defaultValue: + '@path': $.properties.attributionId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 8drKi2r5mUiqpxy7uHo2bB + sortOrder: 12 + fieldKey: referralCode + label: Friendbuy Referral ID + type: STRING + description: >- + Friendbuy referral code that associates the customer who is signing up + with the advocate who referred them. + placeholder: '' + defaultValue: + '@path': $.properties.referralCode + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: vBQ96ZiNZ2vejqxaxYdriJ + sortOrder: 13 + fieldKey: friendbuyAttributes + label: Custom Attributes + type: OBJECT + description: >- + Custom attributes to send to Friendbuy. You should pass an object whose + keys are the names of the custom attributes and whose values are + strings. Non-string-valued attributes will be dropped. + placeholder: '' + defaultValue: + '@path': $.properties.friendbuyAttributes + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: vj1sYaj9saWmcRUVbFaPf5 + name: Track Purchase + slug: trackPurchase + description: Record when a customer makes a purchase. + platform: WEB + hidden: false + defaultTrigger: event = "Order Completed" + fields: + - id: jtDk7HdbW3h775XotYX7RW + sortOrder: 0 + fieldKey: orderId + label: Order ID + type: STRING + description: The order ID. + placeholder: '' + defaultValue: + '@path': $.properties.order_id + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: seyRHj3Jhhsk7kTxXRSLoF + sortOrder: 1 + fieldKey: amount + label: Amount Source + type: NUMBER + description: Purchase amount to be considered when evaluating reward rules. + placeholder: '' + defaultValue: + '@path': $.properties.total + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: erbhwHHEtPwPT7s9GDwC3H + sortOrder: 2 + fieldKey: currency + label: Currency + type: STRING + description: The currency of the purchase amount. + placeholder: '' + defaultValue: + '@path': $.properties.currency + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: apJrPW1frbeo6RF79E1eFs + sortOrder: 3 + fieldKey: coupon + label: Coupon + type: STRING + description: The coupon code of any coupon redeemed with the order. + placeholder: '' + defaultValue: + '@path': $.properties.coupon + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: nbSRtQ5F7vNxhtEuLymfW + sortOrder: 4 + fieldKey: attributionId + label: Friendbuy Attribution ID + type: STRING + description: >- + Friendbuy attribution ID that associates the purchase with the advocate + who referred the purchaser. + placeholder: '' + defaultValue: + '@path': $.properties.attributionId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: x59iiXF7PXj4qX7Z1hXbva + sortOrder: 5 + fieldKey: referralCode + label: Friendbuy Referral ID + type: STRING + description: >- + Friendbuy referral code that associates the purchase with the advocate + who referred the purchaser. + placeholder: '' + defaultValue: + '@path': $.properties.referralCode + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: heQRdcwstpsku192obDNRo + sortOrder: 6 + fieldKey: giftCardCodes + label: Gift Card Codes + type: STRING + description: An array of gift card codes applied to the order. + placeholder: '' + defaultValue: + '@path': $.properties.giftCardCodes + required: false + multiple: true + choices: null + dynamic: false + allowNull: false + - id: jvZjKtMx75aR6DNQa817c + sortOrder: 7 + fieldKey: products + label: Products + type: OBJECT + description: Products purchased. + placeholder: '' + defaultValue: + '@path': $.properties.products + required: false + multiple: true + choices: null + dynamic: false + allowNull: false + - id: e49BnvXt9CdvsHP3gUddny + sortOrder: 8 + fieldKey: customerId + label: Customer ID + type: STRING + description: The user's customer ID. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.properties.customerId + then: + '@path': $.properties.customerId + else: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 7yu3J3PxaUyg3tuidJ7UaK + sortOrder: 9 + fieldKey: anonymousId + label: Anonymous ID + type: STRING + description: The user's anonymous ID. + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: pKJ7PkJzLJPmvHaa276pue + sortOrder: 10 + fieldKey: email + label: Email + type: STRING + description: The user's email address. + placeholder: '' + defaultValue: + '@path': $.properties.email + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: cxk2hBGqKivvjVi9ppjibC + sortOrder: 11 + fieldKey: isNewCustomer + label: New Customer Flag + type: BOOLEAN + description: Flag to indicate whether the user is a new customer. + placeholder: '' + defaultValue: + '@path': $.properties.isNewCustomer + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: aQMFpBXqLfA3PDzRuFtduM + sortOrder: 12 + fieldKey: loyaltyStatus + label: Loyalty Program Status + type: STRING + description: >- + The status of the user in your loyalty program. Valid values are "in", + "out", or "blocked". + placeholder: '' + defaultValue: + '@path': $.properties.loyaltyStatus + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: rrpKTJgzEBSzCPg2vyjG9D + sortOrder: 13 + fieldKey: firstName + label: First Name + type: STRING + description: The user's given name. + placeholder: '' + defaultValue: + '@path': $.properties.firstName + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 3GDjggth5iTiT2dqGK7zGP + sortOrder: 14 + fieldKey: lastName + label: Last Name + type: STRING + description: The user's surname. + placeholder: '' + defaultValue: + '@path': $.properties.lastName + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: Xd4epHNN3sYt48neN9bN3 + sortOrder: 15 + fieldKey: name + label: Name + type: STRING + description: The user's full name. + placeholder: '' + defaultValue: + '@path': $.properties.name + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: bSx5kxfkJoQ1vvcmXm6Ut2 + sortOrder: 16 + fieldKey: age + label: Age + type: NUMBER + description: The user's age. + placeholder: '' + defaultValue: + '@path': $.properties.age + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: hzg7x9k2QSCiBWzBxmwybk + sortOrder: 17 + fieldKey: birthday + label: Birthday + type: STRING + description: >- + The user's birthday in the format "YYYY-MM-DD", or "0000-MM-DD" to omit + the year. + placeholder: '' + defaultValue: + '@path': $.properties.birthday + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: uQbbmFxFGAQJFhBzcHesbB + sortOrder: 18 + fieldKey: friendbuyAttributes + label: Custom Attributes + type: OBJECT + description: >- + Custom attributes to send to Friendbuy. You should pass an object whose + keys are the names of the custom attributes and whose values are + strings. Non-string-valued attributes will be dropped. + placeholder: '' + defaultValue: + '@path': $.properties.friendbuyAttributes + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: wTBkHZFw3Mh66G65UkMXBL + name: Track Customer + slug: trackCustomer + description: Create a new customer profile or update an existing customer profile. + platform: WEB + hidden: false + defaultTrigger: type = "identify" + fields: + - id: AkJRqp7x2vwUdqe97reZD + sortOrder: 0 + fieldKey: customerId + label: Customer ID + type: STRING + description: The user's customer ID. + placeholder: '' + defaultValue: + '@path': $.userId + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: xuoGFMgo6dDoMgFiUiK8dy + sortOrder: 1 + fieldKey: anonymousId + label: Anonymous ID + type: STRING + description: The user's anonymous id. + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: rQ91c85WpwF2cA4U8d59i + sortOrder: 2 + fieldKey: email + label: Email + type: STRING + description: The user's email address. + placeholder: '' + defaultValue: + '@path': $.traits.email + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: dgVNf5a6rpAbzBgK6B4MWA + sortOrder: 3 + fieldKey: firstName + label: First Name + type: STRING + description: The user's given name. + placeholder: '' + defaultValue: + '@path': $.traits.firstName + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: sQQ5Q5QFveS1sr6anuYpTV + sortOrder: 4 + fieldKey: lastName + label: Last Name + type: STRING + description: The user's surname. + placeholder: '' + defaultValue: + '@path': $.traits.lastName + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: miD4YPZSSJAvKashuwP9UK + sortOrder: 5 + fieldKey: name + label: Name + type: STRING + description: >- + The user's full name. If the name trait doesn't exist then it will be + automatically derived from the firstName and lastName traits if they are + defined. + placeholder: '' + defaultValue: + '@path': $.traits.name + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 2PGj2M8YErv7Ssz7M9FdCW + sortOrder: 6 + fieldKey: age + label: Age + type: NUMBER + description: The user's age. + placeholder: '' + defaultValue: + '@path': $.traits.age + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 9eutB7uWDAz8eucRfdqTGS + sortOrder: 7 + fieldKey: birthday + label: Birthday + type: STRING + description: >- + The user's birthday in the format "YYYY-MM-DD", or "0000-MM-DD" to omit + the year. + placeholder: '' + defaultValue: + '@path': $.traits.birthday + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: dLF9tZ39SShVVdoPzxV3Hv + sortOrder: 8 + fieldKey: language + label: Language + type: STRING + description: The user's language. + placeholder: '' + defaultValue: + '@path': $.traits.language + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: wQR61gJCRoK3TrcM5PdZZg + sortOrder: 9 + fieldKey: addressCountry + label: Country + type: STRING + description: The user's country. + placeholder: '' + defaultValue: + '@path': $.traits.address.country + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: t4kb37hYMbbNc4vCjGwKXn + sortOrder: 10 + fieldKey: addressState + label: State + type: STRING + description: The user's state. + placeholder: '' + defaultValue: + '@path': $.traits.address.state + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: nhW4J81o75BkVC5oHV5QeR + sortOrder: 11 + fieldKey: addressCity + label: City + type: STRING + description: The user's city. + placeholder: '' + defaultValue: + '@path': $.traits.address.city + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: tN4BGwdF3QwVThS899pYKG + sortOrder: 12 + fieldKey: addressPostalCode + label: State + type: STRING + description: The user's postal code. + placeholder: '' + defaultValue: + '@path': $.traits.address.postalCode + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 4j9sK8W15BqpywxbBKazQM + sortOrder: 13 + fieldKey: customerSince + label: Customer Since + type: STRING + description: The date the user became a customer. + placeholder: '' + defaultValue: + '@path': $.traits.customerSince + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 4W9aSb3uMBiFo4wixQ1BR7 + sortOrder: 14 + fieldKey: loyaltyStatus + label: Loyalty Status + type: STRING + description: >- + The status of the user in your loyalty program. Valid values are "in", + "out", or "blocked". + placeholder: '' + defaultValue: + '@path': $.traits.loyaltyStatus + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: jVnqS7vnxv4BiVFRAgQ93P + sortOrder: 15 + fieldKey: isNewCustomer + label: New Customer Flag + type: BOOLEAN + description: Flag to indicate whether the user is a new customer. + placeholder: '' + defaultValue: + '@path': $.traits.isNewCustomer + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: po4r4NNZhHZkukEoqWZc1s + sortOrder: 16 + fieldKey: friendbuyAttributes + label: Custom Attributes + type: OBJECT + description: >- + Custom attributes to send to Friendbuy. You should pass an object whose + keys are the names of the custom attributes and whose values are + strings. Non-string-valued attributes will be dropped. + placeholder: '' + defaultValue: + '@path': $.traits.friendbuyAttributes + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + presets: + - actionId: vj1sYaj9saWmcRUVbFaPf5 + name: Track Purchase + fields: + orderId: + '@path': $.properties.order_id + amount: + '@path': $.properties.total + currency: + '@path': $.properties.currency + coupon: + '@path': $.properties.coupon + attributionId: + '@path': $.properties.attributionId + referralCode: + '@path': $.properties.referralCode + giftCardCodes: + '@path': $.properties.giftCardCodes + products: + '@path': $.properties.products + customerId: + '@if': + exists: + '@path': $.properties.customerId + then: + '@path': $.properties.customerId + else: + '@path': $.userId + anonymousId: + '@path': $.anonymousId + email: + '@path': $.properties.email + isNewCustomer: + '@path': $.properties.isNewCustomer + loyaltyStatus: + '@path': $.properties.loyaltyStatus + firstName: + '@path': $.properties.firstName + lastName: + '@path': $.properties.lastName + name: + '@path': $.properties.name + age: + '@path': $.properties.age + birthday: + '@path': $.properties.birthday + friendbuyAttributes: + '@path': $.properties.friendbuyAttributes + trigger: event = "Order Completed" + - actionId: wTBkHZFw3Mh66G65UkMXBL + name: Track Customer + fields: + customerId: + '@path': $.userId + anonymousId: + '@path': $.anonymousId + email: + '@path': $.traits.email + firstName: + '@path': $.traits.firstName + lastName: + '@path': $.traits.lastName + name: + '@path': $.traits.name + age: + '@path': $.traits.age + birthday: + '@path': $.traits.birthday + language: + '@path': $.traits.language + addressCountry: + '@path': $.traits.address.country + addressState: + '@path': $.traits.address.state + addressCity: + '@path': $.traits.address.city + addressPostalCode: + '@path': $.traits.address.postalCode + customerSince: + '@path': $.traits.customerSince + loyaltyStatus: + '@path': $.traits.loyaltyStatus + isNewCustomer: + '@path': $.traits.isNewCustomer + friendbuyAttributes: + '@path': $.traits.friendbuyAttributes + trigger: type = "identify" + - actionId: otSYqZFafJi5aae1yTwynq + name: Track Sign Up + fields: + customerId: + '@if': + exists: + '@path': $.properties.customerId + then: + '@path': $.properties.customerId + else: + '@path': $.userId + anonymousId: + '@path': $.anonymousId + email: + '@path': $.properties.email + isNewCustomer: + '@path': $.properties.isNewCustomer + loyaltyStatus: + '@path': $.properties.loyaltyStatus + firstName: + '@path': $.properties.firstName + lastName: + '@path': $.properties.lastName + name: + '@path': $.properties.name + age: + '@path': $.properties.age + birthday: + '@path': $.properties.birthday + coupon: + '@path': $.properties.coupon + attributionId: + '@path': $.properties.attributionId + referralCode: + '@path': $.properties.referralCode + friendbuyAttributes: + '@path': $.properties.friendbuyAttributes + trigger: event = "Signed Up" + - actionId: fk2xKEXiXd9qEkQb24nzXh + name: Track Page + fields: + name: + '@path': $.name + category: + '@path': $.category + title: + '@path': $.properties.title + trigger: type = "page" +- destination_id: 61dde0dc77eb0db0392649d3 + display_name: Friendbuy (Cloud Destination) + name: Friendbuy (Cloud Destination) + slug: actions-friendbuy-cloud + hidden: false + regional: + - us-west + url: connections/destinations/catalog/actions-friendbuy-cloud + previous_names: + - Friendbuy (Cloud Destination) + website: http://www.segment.com + status: PUBLIC + categories: + - Referrals + logo: + url: https://cdn.filepicker.io/api/file/Lv1D71xoTOH6BxY6wcd4 + mark: + url: https://cdn.filepicker.io/api/file/vVMZxAaTomw7iyVlgSo9 + methods: + track: true + identify: true + group: true + alias: true + page: true + platforms: + browser: true + mobile: false + server: true + components: [] + browserUnbundlingSupported: false + browserUnbundlingPublic: false + replay: false + connection_modes: + device: + web: false + mobile: false + server: false + cloud: + web: false + mobile: false + server: false + settings: + - name: authKey + type: string + defaultValue: '' + description: >- + Contact your Friendbuy account manager to generate your Friendbuy MAPI key + and secret. + required: true + label: Friendbuy MAPI Key + - name: authSecret + type: string + defaultValue: '' + description: See Friendbuy MAPI Key. + required: true + label: Friendbuy MAPI Secret + actions: + - id: jGiVy4jyhXLyWfCbu4t9Rg + name: Track Custom Event + slug: trackCustomEvent + description: Record when a customer completes any custom event that you define. + platform: CLOUD + hidden: false + defaultTrigger: null + fields: + - id: oowkcUpVHmzkBJrJFjy7Gx + sortOrder: 0 + fieldKey: eventType + label: Event Type + type: STRING + description: The type of the event to track. + placeholder: '' + defaultValue: + '@path': $.event + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 5fE31vDVwcyJ7STwddGtoc + sortOrder: 1 + fieldKey: eventProperties + label: Event Properties + type: OBJECT + description: >- + Object containing the properties for the event being tracked. All of the + fields in this object will be sent in the root of the Friendbuy track + event. + placeholder: '' + defaultValue: + '@path': $.properties + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: vc2q1ZTU9LURMdNS5oZ5jj + sortOrder: 2 + fieldKey: deduplicationId + label: Event ID + type: STRING + description: >- + An identifier for the event being tracked to prevent the same event from + being rewarded more than once. + placeholder: '' + defaultValue: + '@path': $.properties.deduplicationId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 6KyKwR3v5R1stV8Ai1yWyL + sortOrder: 3 + fieldKey: customerId + label: Customer ID + type: STRING + description: The user's customer ID. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.properties.customerId + then: + '@path': $.properties.customerId + else: + '@path': $.userId + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: nTza4zUtt7J9inTLaCGBHn + sortOrder: 4 + fieldKey: anonymousId + label: Anonymous ID + type: STRING + description: The user's anonymous id + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: dnm8AgTE6jcgvXTJuVm5v2 + sortOrder: 5 + fieldKey: email + label: Email + type: STRING + description: The user's email address. + placeholder: '' + defaultValue: + '@path': $.properties.email + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 8E22wrRB5nm2Bh5rVaqVvv + sortOrder: 6 + fieldKey: pageUrl + label: Page URL + type: STRING + description: The URL of the web page the event was generated on. + placeholder: '' + defaultValue: + '@path': $.context.page.url + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: JU9ksPnAeWWotgb7TtCWY + sortOrder: 7 + fieldKey: pageTitle + label: Page Title + type: STRING + description: The title of the web page the event was generated on. + placeholder: '' + defaultValue: + '@path': $.context.page.title + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: wZNieDhsTwfjgsTYYuMJhj + sortOrder: 8 + fieldKey: userAgent + label: User Agent + type: STRING + description: The browser's User-Agent string. + placeholder: '' + defaultValue: + '@path': $.context.userAgent + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: g21v8UnT2NgMTqtXy6txS8 + sortOrder: 9 + fieldKey: ipAddress + label: IP Address + type: STRING + description: The users's IP address. + placeholder: '' + defaultValue: + '@path': $.context.ip + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: mgg3vBV3yyXq7GxGdWpsPS + name: Track Sign Up + slug: trackSignUp + description: Record when a customer signs up for a service. + platform: CLOUD + hidden: false + defaultTrigger: null + fields: + - id: mVpzx1Nx2sFdX725PMNfwc + sortOrder: 0 + fieldKey: customerId + label: Customer ID + type: STRING + description: The user's customer ID. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.properties.customerId + then: + '@path': $.properties.customerId + else: + '@path': $.userId + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: iDeMAoiX8dBqvZfVCtRpGu + sortOrder: 1 + fieldKey: anonymousId + label: Anonymous ID + type: STRING + description: The user's anonymous ID. + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: bb81Q5qU2wDxDHJNCftRHt + sortOrder: 2 + fieldKey: email + label: Email + type: STRING + description: The user's email address. + placeholder: '' + defaultValue: + '@path': $.properties.email + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: p12B9pSzPXh7GiF7YT84t7 + sortOrder: 3 + fieldKey: isNewCustomer + label: New Customer Flag + type: BOOLEAN + description: Flag to indicate whether the user is a new customer. + placeholder: '' + defaultValue: + '@path': $.properties.isNewCustomer + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: nnRLte19g1zXhEnTVjMbmB + sortOrder: 4 + fieldKey: loyaltyStatus + label: Loyalty Program Status + type: STRING + description: >- + The status of the user in your loyalty program. Valid values are "in", + "out", or "blocked". + placeholder: '' + defaultValue: + '@path': $.properties.loyaltyStatus + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: uXezUiDYVX19rXwpkoPGqU + sortOrder: 5 + fieldKey: firstName + label: First Name + type: STRING + description: The user's given name. + placeholder: '' + defaultValue: + '@path': $.properties.firstName + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: c5tDaGSBMCt8GcHeWc31Bf + sortOrder: 6 + fieldKey: lastName + label: Last Name + type: STRING + description: The user's surname. + placeholder: '' + defaultValue: + '@path': $.properties.lastName + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: ed6ZW4TgiebaxNnxLHyuyx + sortOrder: 7 + fieldKey: name + label: Name + type: STRING + description: The user's full name. + placeholder: '' + defaultValue: + '@path': $.properties.name + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: oox5BrvQnKTUwuouCnHCuW + sortOrder: 8 + fieldKey: age + label: Age + type: NUMBER + description: The user's age. + placeholder: '' + defaultValue: + '@path': $.properties.age + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 52RrowQ2EFo5i8dJtAjbg5 + sortOrder: 9 + fieldKey: birthday + label: Birthday + type: STRING + description: >- + The user's birthday in the format "YYYY-MM-DD", or "0000-MM-DD" to omit + the year. + placeholder: '' + defaultValue: + '@path': $.properties.birthday + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: v8Xt9wQFrXQsNeHmcCBY9P + sortOrder: 10 + fieldKey: coupon + label: Coupon Code + type: STRING + description: Coupon code that customer supplied when they signed up. + placeholder: '' + defaultValue: + '@path': $.properties.coupon + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: g1Wn5fsKa3UKjo6KFXiS8a + sortOrder: 11 + fieldKey: attributionId + label: Friendbuy Attribution ID + type: STRING + description: >- + Friendbuy attribution ID that associates the customer who is signing up + with the advocate who referred them. + placeholder: '' + defaultValue: + '@path': $.properties.attributionId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: t3fjGpemyUBqP6Hgdd7QdY + sortOrder: 12 + fieldKey: referralCode + label: Friendbuy Referral ID + type: STRING + description: >- + Friendbuy referral code that associates the customer who is signing up + with the advocate who referred them. + placeholder: '' + defaultValue: + '@path': $.properties.referralCode + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: mdxKmKcDYpwbhhG84qRvjV + sortOrder: 13 + fieldKey: friendbuyAttributes + label: Custom Attributes + type: OBJECT + description: >- + Custom attributes to send to Friendbuy. You should pass an object whose + keys are the names of the custom attributes and whose values are + strings. Non-string-valued attributes will be dropped. + placeholder: '' + defaultValue: + '@path': $.properties.friendbuyAttributes + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: s6y497EuoSozVqCMzwYKDj + sortOrder: 14 + fieldKey: pageUrl + label: Page URL + type: STRING + description: The URL of the web page the event was generated on. + placeholder: '' + defaultValue: + '@path': $.context.page.url + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 9MY994crHiwQBd2tZ6N1pL + sortOrder: 15 + fieldKey: pageTitle + label: Page Title + type: STRING + description: The title of the web page the event was generated on. + placeholder: '' + defaultValue: + '@path': $.context.page.title + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 23oANDtBoWVKmwo7SMKBFL + sortOrder: 16 + fieldKey: userAgent + label: User Agent + type: STRING + description: The browser's User-Agent string. + placeholder: '' + defaultValue: + '@path': $.context.userAgent + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: jv4wtdTbrJj2WYZ1DymdiV + sortOrder: 17 + fieldKey: ipAddress + label: IP Address + type: STRING + description: The users's IP address. + placeholder: '' + defaultValue: + '@path': $.context.ip + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: qXnqSX3hkPFkzQRR8K5YJp + name: Track Customer + slug: trackCustomer + description: Create a new customer profile or update an existing customer profile. + platform: CLOUD + hidden: false + defaultTrigger: null + fields: + - id: hyufZTKzkhVVYrbFqzKApD + sortOrder: 0 + fieldKey: customerId + label: Customer ID + type: STRING + description: The user's customer ID. + placeholder: '' + defaultValue: + '@path': $.userId + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: tpxUYtNM6RgnvNZJfcC8DE + sortOrder: 1 + fieldKey: anonymousId + label: Anonymous ID + type: STRING + description: The user's anonymous id. + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: im1MDJmjPihfzjXBiqTTAu + sortOrder: 2 + fieldKey: email + label: Email + type: STRING + description: The user's email address. + placeholder: '' + defaultValue: + '@path': $.traits.email + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: ih1KaVRRyWrJjiVMpoBNBz + sortOrder: 3 + fieldKey: firstName + label: First Name + type: STRING + description: The user's given name. + placeholder: '' + defaultValue: + '@path': $.traits.firstName + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: dGYeLsMuqPLsqViv6ozqWz + sortOrder: 4 + fieldKey: lastName + label: Last Name + type: STRING + description: The user's surname. + placeholder: '' + defaultValue: + '@path': $.traits.lastName + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 5or25ohrdDqT31ZrRDtocE + sortOrder: 5 + fieldKey: name + label: Name + type: STRING + description: >- + The user's full name. If the name trait doesn't exist then it will be + automatically derived from the firstName and lastName traits if they are + defined. + placeholder: '' + defaultValue: + '@path': $.traits.name + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: vFFWALL8gYvTQSVwQPTHsY + sortOrder: 6 + fieldKey: age + label: Age + type: NUMBER + description: The user's age. + placeholder: '' + defaultValue: + '@path': $.traits.age + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: oCLaaUerUXZVKRX2ZEQ4N4 + sortOrder: 7 + fieldKey: birthday + label: Birthday + type: STRING + description: >- + The user's birthday in the format "YYYY-MM-DD", or "0000-MM-DD" to omit + the year. + placeholder: '' + defaultValue: + '@path': $.traits.birthday + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: fm5y5BWYpHvgRLxk8QcyR7 + sortOrder: 8 + fieldKey: language + label: Language + type: STRING + description: The user's language. + placeholder: '' + defaultValue: + '@path': $.traits.language + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 7aEAcqmizMXvrrMPYaWPMD + sortOrder: 9 + fieldKey: addressCountry + label: Country + type: STRING + description: The user's country. + placeholder: '' + defaultValue: + '@path': $.traits.address.country + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: kSfc4sggqPfW2LAoS86YpA + sortOrder: 10 + fieldKey: addressState + label: State + type: STRING + description: The user's state. + placeholder: '' + defaultValue: + '@path': $.traits.address.state + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 5QT67XaNzBvD2bP5BWviGN + sortOrder: 11 + fieldKey: addressCity + label: City + type: STRING + description: The user's city. + placeholder: '' + defaultValue: + '@path': $.traits.address.city + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 7jvw8ogMPSYoUh7e2b5o8q + sortOrder: 12 + fieldKey: addressPostalCode + label: State + type: STRING + description: The user's postal code. + placeholder: '' + defaultValue: + '@path': $.traits.address.postalCode + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: nqCK3EhBEExK543hvjT1QW + sortOrder: 13 + fieldKey: customerSince + label: Customer Since + type: STRING + description: The date the user became a customer. + placeholder: '' + defaultValue: + '@path': $.traits.customerSince + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 7ck4mtXS7pM17qVJPXYbd1 + sortOrder: 14 + fieldKey: loyaltyStatus + label: Loyalty Status + type: STRING + description: >- + The status of the user in your loyalty program. Valid values are "in", + "out", or "blocked". + placeholder: '' + defaultValue: + '@path': $.traits.loyaltyStatus + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: f882GLMrfrr4RCBGLvMT38 + sortOrder: 15 + fieldKey: isNewCustomer + label: New Customer Flag + type: BOOLEAN + description: Flag to indicate whether the user is a new customer. + placeholder: '' + defaultValue: + '@path': $.traits.isNewCustomer + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 4RKrCbou8QR7vWNU9QZNpq + sortOrder: 16 + fieldKey: friendbuyAttributes + label: Custom Attributes + type: OBJECT + description: >- + Custom attributes to send to Friendbuy. You should pass an object whose + keys are the names of the custom attributes and whose values are + strings. Non-string-valued attributes will be dropped. + placeholder: '' + defaultValue: + '@path': $.traits.friendbuyAttributes + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: bRraNNAivMUoy5xi1B7qcH + sortOrder: 17 + fieldKey: pageUrl + label: Page URL + type: STRING + description: The URL of the web page the event was generated on. + placeholder: '' + defaultValue: + '@path': $.context.page.url + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 98taXo3A2L7qBLp2n6vv3U + sortOrder: 18 + fieldKey: pageTitle + label: Page Title + type: STRING + description: The title of the web page the event was generated on. + placeholder: '' + defaultValue: + '@path': $.context.page.title + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: pHYgnkLb6aNpYeBUh86NaW + sortOrder: 19 + fieldKey: userAgent + label: User Agent + type: STRING + description: The browser's User-Agent string. + placeholder: '' + defaultValue: + '@path': $.context.userAgent + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: boje7ArY6dFCB4jc27VEin + sortOrder: 20 + fieldKey: ipAddress + label: IP Address + type: STRING + description: The users's IP address. + placeholder: '' + defaultValue: + '@path': $.context.ip + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: rHduKcyr8ptDrQnFupicxd + name: Track Purchase + slug: trackPurchase + description: Record when a customer makes a purchase. + platform: CLOUD + hidden: false + defaultTrigger: null + fields: + - id: wqe6KdE5WKF22aUQ89YbBk + sortOrder: 0 + fieldKey: orderId + label: Order ID + type: STRING + description: The order ID. + placeholder: '' + defaultValue: + '@path': $.properties.order_id + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: qWq2mTDVazLgkUMyJgBoqG + sortOrder: 1 + fieldKey: amount + label: Amount Source + type: NUMBER + description: Purchase amount to be considered when evaluating reward rules. + placeholder: '' + defaultValue: + '@path': $.properties.total + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: r3tCWiMg4TkJeVnumM61kR + sortOrder: 2 + fieldKey: currency + label: Currency + type: STRING + description: The currency of the purchase amount. + placeholder: '' + defaultValue: + '@path': $.properties.currency + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: sUptyXAjZWNTpp3XRz4oFn + sortOrder: 3 + fieldKey: coupon + label: Coupon + type: STRING + description: The coupon code of any coupon redeemed with the order. + placeholder: '' + defaultValue: + '@path': $.properties.coupon + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 6G1UDvw4eSeH4PAKcDfKjg + sortOrder: 4 + fieldKey: attributionId + label: Friendbuy Attribution ID + type: STRING + description: >- + Friendbuy attribution ID that associates the purchase with the advocate + who referred the purchaser. + placeholder: '' + defaultValue: + '@path': $.properties.attributionId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: wdVUENe5YATHcU9mRoVVXU + sortOrder: 5 + fieldKey: referralCode + label: Friendbuy Referral ID + type: STRING + description: >- + Friendbuy referral code that associates the purchase with the advocate + who referred the purchaser. + placeholder: '' + defaultValue: + '@path': $.properties.referralCode + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: bhWQtNmRgCHKAoW74H8h2J + sortOrder: 6 + fieldKey: giftCardCodes + label: Gift Card Codes + type: STRING + description: An array of gift card codes applied to the order. + placeholder: '' + defaultValue: + '@path': $.properties.giftCardCodes + required: false + multiple: true + choices: null + dynamic: false + allowNull: false + - id: aYi9MVMXoRozMekSzXuPwb + sortOrder: 7 + fieldKey: products + label: Products + type: OBJECT + description: Products purchased. + placeholder: '' + defaultValue: + '@path': $.properties.products + required: false + multiple: true + choices: null + dynamic: false + allowNull: false + - id: i76YK79Z6FdtNstg2wR1mP + sortOrder: 8 + fieldKey: customerId + label: Customer ID + type: STRING + description: The user's customer ID. + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.properties.customerId + then: + '@path': $.properties.customerId + else: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: mT7Di85ZgXTMJi3n7RxG5X + sortOrder: 9 + fieldKey: anonymousId + label: Anonymous ID + type: STRING + description: The user's anonymous ID. + placeholder: '' + defaultValue: + '@path': $.anonymousId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: bUYzGk6i1CVBZoB53TySfS + sortOrder: 10 + fieldKey: email + label: Email + type: STRING + description: The user's email address. + placeholder: '' + defaultValue: + '@path': $.properties.email + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: imjDbTMEmYbpBT2TmX5FY8 + sortOrder: 11 + fieldKey: isNewCustomer + label: New Customer Flag + type: BOOLEAN + description: Flag to indicate whether the user is a new customer. + placeholder: '' + defaultValue: + '@path': $.properties.isNewCustomer + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: LrpY891pMfaoM3EZoCinc + sortOrder: 12 + fieldKey: loyaltyStatus + label: Loyalty Program Status + type: STRING + description: >- + The status of the user in your loyalty program. Valid values are "in", + "out", or "blocked". + placeholder: '' + defaultValue: + '@path': $.properties.loyaltyStatus + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: sNkavPa5RSnet4eWWbENQF + sortOrder: 13 + fieldKey: firstName + label: First Name + type: STRING + description: The user's given name. + placeholder: '' + defaultValue: + '@path': $.properties.firstName + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: v1SY9oFpwEPDkQEar37beY + sortOrder: 14 + fieldKey: lastName + label: Last Name + type: STRING + description: The user's surname. + placeholder: '' + defaultValue: + '@path': $.properties.lastName + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: pWJgQR3w92hSvuAvPCift8 + sortOrder: 15 + fieldKey: name + label: Name + type: STRING + description: The user's full name. + placeholder: '' + defaultValue: + '@path': $.properties.name + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: ua2vy95ckMFNXXEF2eDWqj + sortOrder: 16 + fieldKey: age + label: Age + type: NUMBER + description: The user's age. + placeholder: '' + defaultValue: + '@path': $.properties.age + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: umTCW6h1TVzLBmr53N8Fgf + sortOrder: 17 + fieldKey: birthday + label: Birthday + type: STRING + description: >- + The user's birthday in the format "YYYY-MM-DD", or "0000-MM-DD" to omit + the year. + placeholder: '' + defaultValue: + '@path': $.properties.birthday + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 3VYELbeHb2Y86LRQ9GRxJ2 + sortOrder: 18 + fieldKey: friendbuyAttributes + label: Custom Attributes + type: OBJECT + description: >- + Custom attributes to send to Friendbuy. You should pass an object whose + keys are the names of the custom attributes and whose values are + strings. Non-string-valued attributes will be dropped. + placeholder: '' + defaultValue: + '@path': $.properties.friendbuyAttributes + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: msLckf49ZEaf1KsPfQ4x91 + sortOrder: 19 + fieldKey: pageUrl + label: Page URL + type: STRING + description: The URL of the web page the event was generated on. + placeholder: '' + defaultValue: + '@path': $.context.page.url + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: hoZJWaYBJQ9YhvQSJRF66f + sortOrder: 20 + fieldKey: pageTitle + label: Page Title + type: STRING + description: The title of the web page the event was generated on. + placeholder: '' + defaultValue: + '@path': $.context.page.title + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: iVx6fQYSn1TNrdmteTBr5w + sortOrder: 21 + fieldKey: userAgent + label: User Agent + type: STRING + description: The browser's User-Agent string. + placeholder: '' + defaultValue: + '@path': $.context.userAgent + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: sXZcFy1ehAgpDEJe2eo3zN + sortOrder: 22 + fieldKey: ipAddress + label: IP Address + type: STRING + description: The users's IP address. + placeholder: '' + defaultValue: + '@path': $.context.ip + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + presets: [] - destination_id: 54521fd625e721e32a72eeb8 display_name: FullStory name: FullStory diff --git a/src/_data/catalog/regional-supported.yml b/src/_data/catalog/regional-supported.yml index fc01d76f9b..0e4de476b6 100644 --- a/src/_data/catalog/regional-supported.yml +++ b/src/_data/catalog/regional-supported.yml @@ -1265,6 +1265,18 @@ destinations: url: connections/destinations/catalog/friendbuy regional: - us-west + - id: 6170a348128093cd0245e0ea + display_name: Friendbuy (Actions) + slug: actions-friendbuy + url: connections/destinations/catalog/actions-friendbuy + regional: + - us-west + - id: 61dde0dc77eb0db0392649d3 + display_name: Friendbuy (Cloud Destination) + slug: actions-friendbuy-cloud + url: connections/destinations/catalog/actions-friendbuy-cloud + regional: + - us-west - id: 54521fd625e721e32a72eeb8 display_name: FullStory slug: fullstory diff --git a/src/connections/destinations/catalog/actions-friendbuy-cloud/index.md b/src/connections/destinations/catalog/actions-friendbuy-cloud/index.md new file mode 100644 index 0000000000..b47167423d --- /dev/null +++ b/src/connections/destinations/catalog/actions-friendbuy-cloud/index.md @@ -0,0 +1,126 @@ +--- +title: Friendbuy Cloud Mode (Actions) Destination +hide-boilerplate: true +hide-dossier: true +hidden: false +--- + +{% include content/plan-grid.md name="actions" %} + +[Friendbuy](https://www.friendbuy.com/){:target='_blank'} powers referral programs for e-commerce merchants of all sizes, providing an easy solution to launch Refer-a-Friend programs and accelerate growth through word of mouth. + +Friendbuy's cloud mode Segment integration allows you to send data to Friendbuy from your data center so that Friendbuy can act on it. For example, you could trigger a reward when a referred customer performs a rewardable event or send customer data to use in your Friendbuy-managed loyalty/rewards program. + +If you're using Segment with a Friendbuy referral program you probably want to use the [web destination](/docs/connections/destinations/catalog/actions-friendbuy-web/) to configure the Friendbuy JavaScript and to send customer and purchase data directly to Friendbuy as the user interacts with your web site. However, if you also want to send events from your data center to Friendbuy, such as purchases due to recurring transactions, you should also use this cloud mode [destination action](/docs/connections/destinations/actions/), which provides an interface between Segment's identify and track calls and Friendbuy's MAPI (merchant API). + +## Overview + +The Friendbuy cloud mode destination sends information about your customers and their actions to Friendbuy. It supports the following [Friendbuy MAPI events](https://developers.friendbuy.com/#tracking-events){:target='_blank'}. + +- **Track Customer**: Converts Segment [Identify](/docs/connections/spec/identify/) calls to Friendbuy [*track customer* MAPI calls](https://developers.friendbuy.com/#tracking-customer-details). Use this to add your customer ID and other customer data to the information that Friendbuy has about the customer. +- **Track Purchase**: Converts Segment [Order Completed](/docs/connections/spec/ecommerce/v2/#order-completed) calls to Friendbuy [*track purchase* MAPI calls](https://developers.friendbuy.com/#tracking-a-purchase). Use this to send purchase data to Friendbuy and reward advocates based on their friends' purchases. +- **Track Sign-Up**: Converts Segment [Signed Up](/docs/connections/spec/b2b-saas/#signed-up) calls to Friendbuy [*track sign_up* MAPI calls](https://developers.friendbuy.com/#tracking-a-signup). Use this to reward customers for account creation and other sign-up actions. +- **Track Custom Event**: Converts an arbitrary Segment [`analytics.track`](/docs/connections/sources/catalog/libraries/website/javascript/#track) call with an event name and properties of your choosing to a Friendbuy [track custom event MAPI call](https://developers.friendbuy.com/#tracking-a-custom-event). Use this to reward your customers for actions other than purchases or sign-ups. + +## Benefits of Friendbuy Cloud Mode (Actions) vs Friendbuy Classic + +Friendbuy Cloud Mode (Actions) is the Segment cloud mode destination that works with Friendbuy's current platform. The classic Segment Friendbuy destination works with Friendbuy's legacy platform. + +## Getting started + +> info "" +> Please contact your Friendbuy Customer Success Manager or email support@friendbuy.com to set up Friendbuy's Segment integration. + +1. You need your Friendbuy MAPI Key and MAPI Secret to use the Friendbuy cloud mode integration. Contact your Friendbuy Onboarding & Implementation Representative to have these generated for you. (These are not the same as the Merchant ID and Secret Key that are available in your Friendbuy account.) +2. From the Segment web app, click **Catalog**, then click **Destinations**. +3. Filter the destinations on Friendbuy in the Catalog and select **Friendbuy (Cloud Destinaton)**. Click **Configure (Cloud Destination)** to configure the Friendbuy destination, and choose which of your sources to connect the destination to. +4. Give the destination a name, and fill in the settings manually. +5. On the **Basic Settings** page enter your Friendbuy MAPI Key and Friendbuy MAPI Secret values from step one, and click **Save Changes**. +6. Select the **Mappings** tab. Click the **+ New Mapping** button. A dialog will pop up showing the supported Friendbuy actions. Click the desired type of action you want to send to Friendbuy and configure it using the steps described below. + + + +{% include components/actions-fields.html %} + + + +## Edit Friendbuy mappings + +There are four steps to configure a Segment mapping. + +1. **Set up event trigger**: Choose the event trigger, which is the event type (such as *Identify*) or event name (such as *Order Completed*) for events that should be sent to Friendbuy. +2. **Test event trigger**: Find a sample event in your Segment event stream that matches the trigger you defined in step one. +3. **Configure action fields**: Define how the fields in the Segment event are mapped to fields in the Friendbuy track event. +4. **Review mappings**: Verify that the fields in the sample event are mapped correctly. + +> info "" +> If you use the Friendbuy web mode destination to handle events generated in the browser as recommended, then when you configure the event trigger in the cloud mode destination you might need to add an extra condition to prevent events that come from Analytics.js calls from being handled by both the web and cloud mode destinations. For example, if you configure a Track Purchase action in the cloud mode destination to handle purchases for a recurring subscription, you might want to add an event property named `source` with the value `data center` to the recurring purchase events that you submit to Segment's REST interface. Then, add a condition on that property in the action's trigger so that only Order Completed events in which the Event Property `source` has the value `data center` are handled by that action. This prevents ordinary purchases sent from Analytics.js and processed by the Friendbuy cloud mode destination from being sent a second time by the web mode destination. + +### Configuring action fields + +In the **configure action fields** step, the mapping is pre-populated with mappings from the standard Segment event properties to the corresponding Friendbuy fields. You can edit each field if you want to populate that field from a different Segment event property or not send the field at all. + +#### Custom attributes + +In the *Track Customer*, *Track Purchase*, or *Track Sign Up* mappings you can use the *Custom Attributes* field to send additional custom properties that aren't included in the predefined field names for that event. Use the mapping's *Custom Attributes* field to specify the path to a JSON object that contains those custom attributes. Then, when your code makes its Segment Analytics.js call, include an object at the path that you configured containing your custom attributes. These attributes will then be included in the `additionalProperties` object in the Friendbuy MAPI call. + +For example, if your *Track Purchase* call has the default *Custom Attributes* value of `properties.friendbuyAttributes`, and if your track purchase call is: + +``` json +{ + "type": "track", + "event": "Order Completed", + "source": "data center", + "userId": "customer-12345", + "properties": { + "order_id": "82f250a3-32eb-40be-95fc-77e685ed8448", + "email": "joe.customer@example.com", + "total": 54.82, + "currency": "USD", + "friendbuyAttributes": { + "orderNumber": "3", + "promotion": "black friday" + } + } +} +``` + +then the [Friendbuy MAPI purchase call](https://developers.friendbuy.com/#postpurchaseevent){:target='_blank'} will be: + +``` json +{ + "orderId": "82f250a3-32eb-40be-95fc-77e685ed8448", + "email": "joe.customer@example.com", + "customerId": "customer-12345", + "amount": 54.82, + "currency": "USD", + "additionalProperties": { + "orderNumber": "3", + "promotion": "black friday" + } +} +``` + +Note that a Friendbuy MAPI call is limited to a maximum of 10 additional properties, additional properties' values must be strings, and the maximum length of an additional property's value is 128 characters. Additional properties that don't comply with these restrictions are dropped. + +### Custom events + +To allow Friendbuy to act on an event that isn't one of the standard events described in the [Overview](#overview), use a custom event. + +To configure a custom event: + +1. Click **New Mapping** and choose **Track Custom Event**. + +2. When you configure the event trigger, for the Event Name choose the name of the Segment event you're tracking. For example, if you want to reward on app downloads that you're tracking with `{ "type": "track", "event": "Downloaded", ... }`, use `Downloaded` as the *Event Name* in the trigger. + +3. When you configure your action fields, you can accept the default *Event Type* of `event` which will cause Friendbuy to receive track events with the same names as the Segment events. If you want to rename the Friendbuy events, you can replace the *Event Type* with a different value, such as the static string `download`. + +4. *Event Properties* is set from the path `properties` by default, which means that all the properties that you include in your Segment `analytics.track` call are passed to Friendbuy. If you only want to pass custom attributes to Friendbuy, you need to segregate the fields to pass to Friendbuy into an object and then specify the path to that object, similar to what is described above in [Custom Attributes](#custom-attributes). + +5. To prevent an event that is tracked multiple times from being rewarded more than once, you should include a deduplication ID in your event as described in Friendbuy's [Track Custom Event documentation](https://developers.friendbuy.com/#tracking-a-custom-event){:target='_blank'}. You can either pass an explicit Event ID field in your event (defaulting to the `deduplicationId` property) or you can create the Event ID out of other event properties (such as the `userId`, a `.`, and the `properties.downloadId` in the above example). + + diff --git a/src/connections/destinations/catalog/actions-friendbuy/index.md b/src/connections/destinations/catalog/actions-friendbuy/index.md index 926525feab..34345c7e23 100644 --- a/src/connections/destinations/catalog/actions-friendbuy/index.md +++ b/src/connections/destinations/catalog/actions-friendbuy/index.md @@ -2,20 +2,25 @@ title: Friendbuy Web Mode (Actions) Destination hide-boilerplate: true hide-dossier: true -hidden: true +hidden: false --- + + {% include content/plan-grid.md name="actions" %} [Friendbuy](https://www.friendbuy.com/){:target='_blank'} is a referral marketing platform. -Friendbuy's Segment integration allows you to enable your Friendbuy referral program through Segment's dashboard instead of adding Friendbuy's JavaScript directly to your site. +Friendbuy's web mode Segment integration allows you to enable your Friendbuy referral program through Segment's dashboard instead of adding Friendbuy's JavaScript directly to your site. + +This Segment integration is a web mode [destination action](/docs/connections/destinations/actions/) that loads and configures Friendbuy's JavaScript for you. If you're already using Segment's Analytics.js to identify your customers and track their purchases, either directly or through Segment source integrations that you've installed, you can configure Segment to send this data to Friendbuy for use in your referral program. -Friendbuy's Segment integration is implemented as a Segment browser [destination action](/docs/connections/destinations/actions/) that loads and configures Friendbuy's JavaScript for you. If you're already using Segment's Analytics.js to identify your customers and track their purchases, either directly or through Segment source integrations that you've installed, you can configure Segment to send this data to Friendbuy and use in your referral program. +> warning "" +> The Friendbuy JavaScript won't be loaded unless at least one Mapping is enabled. Even if you're not sending data to Friendbuy through Analytics.js calls, if you're using Segment to load the Friendbuy JavaScript you must define and enable at least one Mapping. A safe mapping to enable is the pre-built **Track Page** mapping. ## Overview -The Friendbuy destination sends information about your customers and their actions to Friendbuy. It supports the following [Friendbuy tracking events](https://developers.friendbuy.com/#tracking-events){:target='_blank'}. +The Friendbuy web mode destination sends information about your customers and their actions to Friendbuy. It supports the following [Friendbuy tracking events](https://developers.friendbuy.com/#tracking-events){:target='_blank'}. - **Track Customer**: Converts Segment [`analytics.identify`](/docs/connections/spec/identify/) calls to Friendbuy *track customer* calls. Use this to add your customer ID and other customer data to the information that Friendbuy has about the customer. - **Track Purchase**: Converts Segment [`analytics.track('Order Completed')`](/docs/connections/spec/ecommerce/v2/#order-completed) calls to Friendbuy *track purchase* calls. Use this to send purchase data to Friendbuy and reward advocates based on their friends' purchases. @@ -30,7 +35,7 @@ Friendbuy Web Mode (Actions) is the Segment web mode destination that works with ## Getting started > info "" -> Please contact your Onboarding & Implementation Representative or email support@friendbuy.com to set up Friendbuy's Segment integration. +> Please contact your Friendbuy Customer Success Manager or email support@friendbuy.com to set up Friendbuy's Segment integration. Before you start, you must have Segment's Analytics.js 2.0 installed on your site. See [Segment's documentation](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/) for instructions. @@ -40,7 +45,7 @@ Before you start, you must have Segment's Analytics.js 2.0 installed on your sit 4. Give the destination a name, and fill in the settings manually. 5. On the **Basic Settings** page enter your Merchant ID value from step one, and click **Save Changes**. 6. Select the **Mappings** tab. A number of pre-built mappings are configured for you that map standard events defined in the [Segment Spec](/docs/connections/spec/) to their equivalent Friendbuy events, as displayed below. You can disable events that you don't use or edit the pre-built field mappings. -7. After you configure the destination, enable it from the **Settings** tab. +7. After you configure the destination, enable it from the **Settings** tab. As noted above, the Friendbuy JavaScript will not be loaded unless at least one Mapping is enabled. ## Pre-built mappings @@ -87,7 +92,7 @@ analytics.track("Order Completed", { currency: "USD", friendbuyAttributes: { orderNumber: "3", - promotion: "black friday" + promotion: "black friday" } }); ``` @@ -116,7 +121,7 @@ To configure a custom event: 2. For the Event Name, choose the name of the Segment event you are tracking. For example, if you want to reward on app downloads that you are tracking with `analytics.track("Downloaded", { downloadId: "My App" }`, select `Downloaded` as your *Event Name*. -3. When you configure your action fields, you can accept the default *Event Name* of `event` which will cause Friendbuy to receive track events with the same names as the Segment events. If you want to rename the Friendbuy events, you can replace the *Event Name* with a different value such as the static string `download`. +3. When you configure your action fields, you can accept the default *Event Type* of `event` which will cause Friendbuy to receive track events with the same names as the Segment events. If you want to rename the Friendbuy events, you can replace the *Event Type* with a different value, such as the static string `download`. 4. *Event Properties* is set from the path `properties` by default, which means that all the properties that you include in your Segment `analytics.track` call are passed to Friendbuy. If you only want to pass custom attributes to Friendbuy, you need to segregate the fields to pass to Friendbuy into an object and then specify the path to that object, similar to what is described above in [Custom Attributes](#custom-attributes). diff --git a/src/connections/destinations/catalog/friendbuy-actions/index.md b/src/connections/destinations/catalog/friendbuy-actions/index.md new file mode 100644 index 0000000000..49bbf3adad --- /dev/null +++ b/src/connections/destinations/catalog/friendbuy-actions/index.md @@ -0,0 +1,5 @@ +--- +title: 'Friendbuy (Actions) Destination' +hidden: true +published: false +--- diff --git a/src/connections/destinations/catalog/friendbuy-cloud-destination/index.md b/src/connections/destinations/catalog/friendbuy-cloud-destination/index.md new file mode 100644 index 0000000000..dc3e4fcf3e --- /dev/null +++ b/src/connections/destinations/catalog/friendbuy-cloud-destination/index.md @@ -0,0 +1,5 @@ +--- +title: 'Friendbuy (Cloud Destination) Destination' +hidden: true +published: false +--- From 039c1dcabd0536c2db4233ecbb7f28273e1e0f76 Mon Sep 17 00:00:00 2001 From: markzegarelli Date: Tue, 1 Feb 2022 15:22:42 -0800 Subject: [PATCH 3/4] remove dupe default mappings --- .../destinations/catalog/actions-friendbuy/index.md | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/src/connections/destinations/catalog/actions-friendbuy/index.md b/src/connections/destinations/catalog/actions-friendbuy/index.md index 34345c7e23..330d9d31fa 100644 --- a/src/connections/destinations/catalog/actions-friendbuy/index.md +++ b/src/connections/destinations/catalog/actions-friendbuy/index.md @@ -47,17 +47,6 @@ Before you start, you must have Segment's Analytics.js 2.0 installed on your sit 6. Select the **Mappings** tab. A number of pre-built mappings are configured for you that map standard events defined in the [Segment Spec](/docs/connections/spec/) to their equivalent Friendbuy events, as displayed below. You can disable events that you don't use or edit the pre-built field mappings. 7. After you configure the destination, enable it from the **Settings** tab. As noted above, the Friendbuy JavaScript will not be loaded unless at least one Mapping is enabled. -## Pre-built mappings - -By default, a Friendbuy Web Mode (Actions) Destination comes with the following mappings. - -| Mapping Name | Trigger | Friendbuy Action | -|----------------|-------------------------------------------|------------------| -| Track Customer | `identify` calls | Track Customer | -| Track Purchase | `track` calls with name `Order Completed` | Track Purchase | -| Track Sign Up | `track` calls with name `Signed Up` | Track Sign Up | -| Track Page | `page` calls | Track Page | - {% include components/actions-fields.html %} From 150537eef97e50c3528bc74bd6a58531f932fe46 Mon Sep 17 00:00:00 2001 From: stayseesong Date: Wed, 2 Feb 2022 11:49:36 -0800 Subject: [PATCH 4/4] redirect added for the old data residency page to regional segment --- src/guides/regional-segment.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/guides/regional-segment.md b/src/guides/regional-segment.md index 3160e316db..542b8d50c9 100644 --- a/src/guides/regional-segment.md +++ b/src/guides/regional-segment.md @@ -3,6 +3,7 @@ title: Regional Segment redirect_from: - '/connections/regional-segment/' - '/docs/connections/regional-segment-eu/' + - '/docs/connections/data-residency/' --- {% include content/plan-grid.md name="data-residency" %}