Skip to content

[index.md] docs for new Jivox destination #2692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/Vocab/Docs/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ iOS
Javadoc
Javadocs
Javascript
Jivox
Kameleoon
Kissmetrics
Lightbox
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/destination_categories.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
113 changes: 112 additions & 1 deletion src/_data/catalog/destinations.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
26 changes: 25 additions & 1 deletion src/_data/catalog/regional-supported.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion src/_data/catalog/source_categories.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -43,5 +43,7 @@ items:
slug: sms-push-notifications
- display_name: Surveys
slug: surveys
- display_name: Warehouse
slug: warehouse
- display_name: Website
slug: website
17 changes: 16 additions & 1 deletion src/_data/catalog/sources.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down
78 changes: 78 additions & 0 deletions src/connections/destinations/catalog/jivox/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
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).

## 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](/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](/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](/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.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Snowflake Source'
hidden: true
---
1 change: 1 addition & 0 deletions vale-styles/Vocab/Docs/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ iOS
Javadoc
Javadocs
Javascript
Jivox
Kameleoon
Kissmetrics
Lightbox
Expand Down