From 905c21cf518fe173af334d3ae22f7f4134f79f99 Mon Sep 17 00:00:00 2001 From: Thomas Gilbert Date: Fri, 1 Apr 2022 12:23:30 -0400 Subject: [PATCH 1/2] [index.md] docs for new Jivox destination --- .../destinations/catalog/jivox/index.md | 78 +++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 src/connections/destinations/catalog/jivox/index.md diff --git a/src/connections/destinations/catalog/jivox/index.md b/src/connections/destinations/catalog/jivox/index.md new file mode 100644 index 0000000000..4c90e0628c --- /dev/null +++ b/src/connections/destinations/catalog/jivox/index.md @@ -0,0 +1,78 @@ +--- +Title: Jivox IQ Destination +--- + +[Jivox](https://jivox.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) personalizes digital marketing and advertising. Using the power of big data and machine learning algorithms, Jivox IQ assembles thousands of creative and messaging variations in real-time to create millions of personalized conversations. + +This destination is maintained by Jivox. For any issues with the destination, [contact the Jivox Support team](mailto:support@jivox.com). + +## Getting Started + +{% include content/connection-modes.md %} + +1. Contact [Jivox IQ Support Team](mailto:support@jivox.com?subject=Need%20API%20key%20for%20Segment%20Destination%20configuration%20for%20) to get the API Key. +2. From the Destinations catalog page in the Segment App, click **Add Destination**. +3. Search for "Jivox IQ" in the Destinations Catalog, and select the "Jivox IQ" destination. +4. Choose which Source should send data to the "Jivox IQ" destination. +5. Enter the "API Key" in the "Jivox IQ" destination settings in Segment. + + +## Supported methods + +Jivox IQ supports the following methods, as specified in the [Segment Spec](/docs/connections/spec). + +### Page + +Send [Page](https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/#page) calls to understand the user journey. For example: + +```js +let properties = { + jvxUserId: 'a345pf56', + ...otherProperties +}; +analytics.page(properties); +``` + +Segment sends Page calls to Jivox IQ as a `pageview`. + +### Screen + +Send [Screen](/docs/connections/spec/screen) calls to understand the user journey. For example: + +```obj-c +[[SEGAnalytics sharedAnalytics] screen:@"Home" + properties:@{ @"jvxUserId": @"a345pf56" }]; + +``` + +Segment sends Screen calls to Jivox IQ as a `screenview`. + + +### Identify + +Send [Identify](https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/#identify) calls to connect Jivox IQ User identified by `jvxUserId` with Segment User identified by `anonymousId/userId`. Send the `jvxUserId` as userId in `identify` call. For example: + +```js +let jvxUserId = 'a345pf56'; +analytics.identify(jvxUserId, { + email: 'john.doe@example.com' +}); +``` + +The userId becomes the primary key used to identify user attributes, event, conversions across later user activity events. These are then used to personalise the ad serving. + +Segment sends Identify calls to Jivox IQ as an `identify` event. + +### Track + +Send [Track](https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/#track) calls to track user conversions and other actions. For example: + +```js +let properties = { + jvxUserId: 'a345pf56', + ...otherProperties +} +analytics.track('Login Button Clicked', properties); +``` + +Segment sends Track calls to Jivox IQ as a `track` event. From b5763fd30f35d16292f5405b812b84168c01d025 Mon Sep 17 00:00:00 2001 From: markzegarelli Date: Fri, 1 Apr 2022 11:16:20 -0700 Subject: [PATCH 2/2] catalog and cleanup --- .github/Vocab/Docs/accept.txt | 1 + src/_data/catalog/destination_categories.yml | 2 +- src/_data/catalog/destinations.yml | 113 +++++++++++++++++- src/_data/catalog/regional-supported.yml | 26 +++- src/_data/catalog/source_categories.yml | 4 +- src/_data/catalog/sources.yml | 17 ++- .../destinations/catalog/jivox/index.md | 10 +- .../catalog/cloud-apps/snowflake/index.md | 4 + vale-styles/Vocab/Docs/accept.txt | 1 + 9 files changed, 168 insertions(+), 10 deletions(-) create mode 100644 src/connections/sources/catalog/cloud-apps/snowflake/index.md diff --git a/.github/Vocab/Docs/accept.txt b/.github/Vocab/Docs/accept.txt index c367220188..0db37ab47f 100644 --- a/.github/Vocab/Docs/accept.txt +++ b/.github/Vocab/Docs/accept.txt @@ -44,6 +44,7 @@ iOS Javadoc Javadocs Javascript +Jivox Kameleoon Kissmetrics Lightbox diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index 2574b4b579..279078bf3b 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-03-24 +# destination categories last updated 2022-04-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 08351a8a62..610b34b4df 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-03-24 +# destination data last updated 2022-04-01 items: - id: 60b5d0a01f3726b85dc05aab display_name: 2mee @@ -1830,6 +1830,60 @@ items: label: Client ID actions: [] presets: [] +- id: 62274854b16140600b51d1cd + display_name: Amberflo + name: Amberflo + slug: amberflo + hidden: true + endpoints: + - us + regions: + - us + url: connections/destinations/catalog/amberflo + previous_names: + - Amberflo + website: https://amberflo.io + status: PUBLIC_BETA + categories: + - Analytics + - CRM + - Deep Linking + logo: + url: https://cdn.filepicker.io/api/file/lRH58DiAQRyZkN2Fkhnc + mark: + url: https://cdn.filepicker.io/api/file/AgEt8EQiQXKrgcaTjSPE + methods: + track: true + identify: true + group: false + alias: false + 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: Enter your Amberflo.io API Key + required: true + label: API Key + actions: [] + presets: [] - id: 54521fd525e721e32a72ee91 display_name: Amplitude name: Amplitude @@ -23137,6 +23191,63 @@ items: label: Track Named Pages actions: [] presets: [] +- id: 61a0f8fdc53f13a42eac137c + display_name: Jivox + name: Jivox + slug: jivox + hidden: false + endpoints: + - us + regions: + - us + url: connections/destinations/catalog/jivox + previous_names: + - Jivox + website: https://jivox.com + status: PUBLIC_BETA + categories: + - Marketing Automation + - Personalization + - Advertising + - Email Marketing + logo: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/72271f9a-1266-4ac1-ad1e-38a67a2237d5.svg + mark: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/7803652a-1475-43ad-931a-8c2801809aa8.svg + methods: + track: true + identify: true + group: false + alias: false + 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: 'Enter the API Key that Jivox team has provided you. ' + required: true + label: API Key + actions: [] + presets: [] - id: 607d4f97829762f3b69a807b display_name: journy io name: journy io diff --git a/src/_data/catalog/regional-supported.yml b/src/_data/catalog/regional-supported.yml index d1ad9c84bc..a9f2cb02fb 100644 --- a/src/_data/catalog/regional-supported.yml +++ b/src/_data/catalog/regional-supported.yml @@ -1,5 +1,5 @@ # AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL -# Last updated 2022-03-24 +# Last updated 2022-04-01 warehouses: - id: WcjBCzUGff display_name: Azure SQL Data Warehouse @@ -639,6 +639,14 @@ sources: - us endpoints: - us + - id: BQp3zGUgjV + display_name: Snowflake + slug: snowflake + url: connections/sources/catalog/cloud-apps/snowflake + regions: + - us + endpoints: + - us - id: 1bow82lmk display_name: Stripe slug: stripe @@ -879,6 +887,14 @@ destinations: - eu endpoints: - us + - id: 62274854b16140600b51d1cd + display_name: Amberflo + slug: amberflo + url: connections/destinations/catalog/amberflo + regions: + - us + endpoints: + - us - id: 54521fd525e721e32a72ee91 display_name: Amplitude slug: amplitude @@ -2170,6 +2186,14 @@ destinations: - eu endpoints: - us + - id: 61a0f8fdc53f13a42eac137c + display_name: Jivox + slug: jivox + url: connections/destinations/catalog/jivox + regions: + - us + endpoints: + - us - id: 607d4f97829762f3b69a807b display_name: journy io slug: journy-io diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml index b52152397f..52fa7728bc 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-03-24 +# source cateogries last updated 2022-04-01 items: - display_name: A/B Testing slug: a-b-testing @@ -43,5 +43,7 @@ items: slug: sms-push-notifications - display_name: Surveys slug: surveys + - display_name: Warehouse + slug: warehouse - display_name: Website slug: website diff --git a/src/_data/catalog/sources.yml b/src/_data/catalog/sources.yml index d474338c32..dbc7195eaf 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-03-24 +# sources last updated 2022-04-01 items: - id: 8HWbgPTt3k display_name: .NET @@ -1192,6 +1192,21 @@ items: url: https://cdn.filepicker.io/api/file/o871amWREKVzwCH3GNXN categories: - Website + - id: BQp3zGUgjV + display_name: Snowflake + slug: snowflake + url: connections/sources/catalog/cloud-apps/snowflake + hidden: false + regions: + - us + endpoints: + - us + source_type: cloud-app + description: Use Snowflake as a Warehouse Source for Reverse ETL. + logo: + url: https://cdn.filepicker.io/api/file/JrQWOYvMRRCVvSHp4HL0 + categories: + - Warehouse - id: 1bow82lmk display_name: Stripe slug: stripe diff --git a/src/connections/destinations/catalog/jivox/index.md b/src/connections/destinations/catalog/jivox/index.md index 4c90e0628c..ea23853a0b 100644 --- a/src/connections/destinations/catalog/jivox/index.md +++ b/src/connections/destinations/catalog/jivox/index.md @@ -1,7 +1,7 @@ --- -Title: Jivox IQ Destination +title: Jivox IQ Destination +id: 61a0f8fdc53f13a42eac137c --- - [Jivox](https://jivox.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) personalizes digital marketing and advertising. Using the power of big data and machine learning algorithms, Jivox IQ assembles thousands of creative and messaging variations in real-time to create millions of personalized conversations. This destination is maintained by Jivox. For any issues with the destination, [contact the Jivox Support team](mailto:support@jivox.com). @@ -23,7 +23,7 @@ Jivox IQ supports the following methods, as specified in the [Segment Spec](/doc ### Page -Send [Page](https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/#page) calls to understand the user journey. For example: +Send [Page](/docs/connections/sources/catalog/libraries/website/javascript/#page) calls to understand the user journey. For example: ```js let properties = { @@ -50,7 +50,7 @@ Segment sends Screen calls to Jivox IQ as a `screenview`. ### Identify -Send [Identify](https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/#identify) calls to connect Jivox IQ User identified by `jvxUserId` with Segment User identified by `anonymousId/userId`. Send the `jvxUserId` as userId in `identify` call. For example: +Send [Identify](/docs/connections/sources/catalog/libraries/website/javascript/#identify) calls to connect Jivox IQ User identified by `jvxUserId` with Segment User identified by `anonymousId/userId`. Send the `jvxUserId` as userId in `identify` call. For example: ```js let jvxUserId = 'a345pf56'; @@ -65,7 +65,7 @@ Segment sends Identify calls to Jivox IQ as an `identify` event. ### Track -Send [Track](https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/#track) calls to track user conversions and other actions. For example: +Send [Track](/docs/connections/sources/catalog/libraries/website/javascript/#track) calls to track user conversions and other actions. For example: ```js let properties = { diff --git a/src/connections/sources/catalog/cloud-apps/snowflake/index.md b/src/connections/sources/catalog/cloud-apps/snowflake/index.md new file mode 100644 index 0000000000..ac1e3d3e4a --- /dev/null +++ b/src/connections/sources/catalog/cloud-apps/snowflake/index.md @@ -0,0 +1,4 @@ +--- +title: 'Snowflake Source' +hidden: true +--- \ No newline at end of file diff --git a/vale-styles/Vocab/Docs/accept.txt b/vale-styles/Vocab/Docs/accept.txt index c367220188..0db37ab47f 100644 --- a/vale-styles/Vocab/Docs/accept.txt +++ b/vale-styles/Vocab/Docs/accept.txt @@ -44,6 +44,7 @@ iOS Javadoc Javadocs Javascript +Jivox Kameleoon Kissmetrics Lightbox