From ada94bf3f9726cc07bd9c18ae449788e7fb2d09e Mon Sep 17 00:00:00 2001 From: Paul Yoo Date: Tue, 18 May 2021 13:57:26 -0600 Subject: [PATCH 1/5] HeadsUp AI docs --- src/_data/catalog/destination_categories.yml | 2 +- src/_data/catalog/destinations.yml | 56 +++++++++++++++++- src/_data/catalog/source_categories.yml | 2 +- src/_data/catalog/sources.yml | 2 +- .../destinations/catalog/headsup-ai/index.md | 57 +++++++++++++++++++ 5 files changed, 115 insertions(+), 4 deletions(-) create mode 100644 src/connections/destinations/catalog/headsup-ai/index.md diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index 99686c8afc..1d77bd1419 100644 --- a/src/_data/catalog/destination_categories.yml +++ b/src/_data/catalog/destination_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT -# destination categories last updated 2021-05-17 +# destination categories last updated 2021-05-18 items: - display_name: Email Marketing slug: email-marketing diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index 381e51a154..90bf336f29 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT -# destination data last updated 2021-05-17 +# destination data last updated 2021-05-18 items: - display_name: ActiveCampaign slug: activecampaign @@ -11119,6 +11119,60 @@ items: regexp: '' description: The name of your workspace settings: [] +- display_name: HeadsUp AI + slug: headsup-ai + name: catalog/destinations/headsup-ai + url: connections/destinations/catalog/headsup-ai + description: Determine User Health Scores + hidden: false + status: PUBLIC_BETA + previous_names: + - HeadsUp AI + logo: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/1c80a592-0ede-451d-9aa8-a017601606ea.svg + mark: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/7618c303-890b-42ed-b3fe-c70130fdd629.svg + categories: + - Analytics + - CRM + - Customer Success + methods: + alias: false + group: true + identify: true + page_view: true + track: true + components: [] + platforms: + browser: true + server: true + mobile: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + connection_modes: + device: + web: false + mobile: false + server: false + cloud: + web: false + mobile: false + server: false + summary: No connection mode information available. + cmode_type: none + case: '0' + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^.{8,}$' + description: You can find your API key within the HeadsUp onboarding flow. + settings: [] - display_name: Heap slug: heap name: catalog/destinations/heap diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml index bc218da8fa..73dfcc6bff 100644 --- a/src/_data/catalog/source_categories.yml +++ b/src/_data/catalog/source_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT -# source cateogries last updated 2021-05-17 +# source cateogries last updated 2021-05-18 items: - display_name: Server slug: server diff --git a/src/_data/catalog/sources.yml b/src/_data/catalog/sources.yml index e9416a5156..918678001b 100644 --- a/src/_data/catalog/sources.yml +++ b/src/_data/catalog/sources.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT -# sources last updated 2021-05-17 +# sources last updated 2021-05-18 items: - display_name: .NET slug: net diff --git a/src/connections/destinations/catalog/headsup-ai/index.md b/src/connections/destinations/catalog/headsup-ai/index.md new file mode 100644 index 0000000000..a742a2af97 --- /dev/null +++ b/src/connections/destinations/catalog/headsup-ai/index.md @@ -0,0 +1,57 @@ +--- +title: HeadsUp AI Destination +rewrite: true +--- + +[HeadsUp](https://headsup.ai?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) allows customers to build metrics on top of their existing segment analytics to better understand customer behavior and gauge health scores. + +This destination is maintained by HeadsUp. For any issues with the destination, [contact the HeadsUp Support team](mailto:administration@headsup.ai). + +## Getting Started + +{% include content/connection-modes.md %} + +1. From the Destinations catalog page in the Segment App, click **Add Destination**. +2. Search for "HeadsUp AI" in the Destinations Catalog, and select the HeadsUp AI Destination. +3. Choose which Source should send data to the HeadsUp AI destination. +4. Go to the [HeadsUp Onboarding](https://app.headsup.ai/welcome) page, find and copy the "Segment API key". +5. Enter the "API Key" in the HeadsUp AI Destination settings in Segment. + +## Identify + +If you aren't familiar with the Segment Spec, take a look at the [Identify method documentation](https://segment.com/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 HeadsUp as an `identify` event. The `email` field is required. Identify calls without an email fail with a `400` code. + +## Track + +If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](https://segment.com/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 HeadsUp as a `track` event. Use Track events to perform metric aggregations, such as how many times a user has logged into your application in the past 30 days. + +## Page + +If you aren't familiar with the Segment Spec, take a look at the [Page method documentation](https://segment.com/docs/connections/spec/page/) to learn about what it does. An example call would look like: + +```js +analytics.page() +``` +Segment sends Page calls to HeadsUp as a `pageview`. + +## Group +If you aren’t familiar with the Segment Spec, take a look at the [Group method documentation](https://segment.com/docs/connections/spec/group/) to learn about what it does. An example call would look like: + +```js +analytics.group("0e8c78ea9d97a7b8185e8632", { + name: "HeadsUp" +}); +``` +Segment sends Group calls to HeadsUp as a `group` event. Use Group events to aggregate user behavior across organizations. From 36523b57d68f47ed20e20c2170d24d95e3c8810d Mon Sep 17 00:00:00 2001 From: Paul Yoo Date: Tue, 18 May 2021 13:59:05 -0600 Subject: [PATCH 2/5] adding AI --- src/connections/destinations/catalog/headsup-ai/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/connections/destinations/catalog/headsup-ai/index.md b/src/connections/destinations/catalog/headsup-ai/index.md index a742a2af97..cc9eaff547 100644 --- a/src/connections/destinations/catalog/headsup-ai/index.md +++ b/src/connections/destinations/catalog/headsup-ai/index.md @@ -3,9 +3,9 @@ title: HeadsUp AI Destination rewrite: true --- -[HeadsUp](https://headsup.ai?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) allows customers to build metrics on top of their existing segment analytics to better understand customer behavior and gauge health scores. +[HeadsUp AI](https://headsup.ai?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) allows customers to build metrics on top of their existing segment analytics to better understand customer behavior and gauge health scores. -This destination is maintained by HeadsUp. For any issues with the destination, [contact the HeadsUp Support team](mailto:administration@headsup.ai). +This destination is maintained by HeadsUp. For any issues with the destination, [contact the HeadsUp AI Support team](mailto:administration@headsup.ai). ## Getting Started From 04ec7d633427e394ecb2bb8903c1c45f84fc5b82 Mon Sep 17 00:00:00 2001 From: pauljaeinyoo Date: Tue, 18 May 2021 15:35:07 -0600 Subject: [PATCH 3/5] Update src/connections/destinations/catalog/headsup-ai/index.md Co-authored-by: LRubin --- src/connections/destinations/catalog/headsup-ai/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/headsup-ai/index.md b/src/connections/destinations/catalog/headsup-ai/index.md index cc9eaff547..727ab9d147 100644 --- a/src/connections/destinations/catalog/headsup-ai/index.md +++ b/src/connections/destinations/catalog/headsup-ai/index.md @@ -3,7 +3,7 @@ title: HeadsUp AI Destination rewrite: true --- -[HeadsUp AI](https://headsup.ai?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) allows customers to build metrics on top of their existing segment analytics to better understand customer behavior and gauge health scores. +[HeadsUp AI](https://headsup.ai?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) allows customers to build metrics on top of their existing Segment analytics to better understand customer behavior and gauge health scores. This destination is maintained by HeadsUp. For any issues with the destination, [contact the HeadsUp AI Support team](mailto:administration@headsup.ai). From 84390cf07a07e0561c0a074c4a1f923ccbeaa75c Mon Sep 17 00:00:00 2001 From: pauljaeinyoo Date: Tue, 18 May 2021 15:35:14 -0600 Subject: [PATCH 4/5] Update src/connections/destinations/catalog/headsup-ai/index.md Co-authored-by: LRubin --- src/connections/destinations/catalog/headsup-ai/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/headsup-ai/index.md b/src/connections/destinations/catalog/headsup-ai/index.md index 727ab9d147..d5e163559c 100644 --- a/src/connections/destinations/catalog/headsup-ai/index.md +++ b/src/connections/destinations/catalog/headsup-ai/index.md @@ -15,7 +15,7 @@ This destination is maintained by HeadsUp. For any issues with the destination, 2. Search for "HeadsUp AI" in the Destinations Catalog, and select the HeadsUp AI Destination. 3. Choose which Source should send data to the HeadsUp AI destination. 4. Go to the [HeadsUp Onboarding](https://app.headsup.ai/welcome) page, find and copy the "Segment API key". -5. Enter the "API Key" in the HeadsUp AI Destination settings in Segment. +5. Back in the Segment App, go back to the the HeadsUp AI Destination settings, and enter the "API Key". ## Identify From a705dfe331c6bdfd9f0acc3f891597501cd2093d Mon Sep 17 00:00:00 2001 From: pauljaeinyoo Date: Tue, 18 May 2021 15:35:49 -0600 Subject: [PATCH 5/5] Update src/connections/destinations/catalog/headsup-ai/index.md Co-authored-by: LRubin --- src/connections/destinations/catalog/headsup-ai/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/headsup-ai/index.md b/src/connections/destinations/catalog/headsup-ai/index.md index d5e163559c..a4ab9f53fa 100644 --- a/src/connections/destinations/catalog/headsup-ai/index.md +++ b/src/connections/destinations/catalog/headsup-ai/index.md @@ -35,7 +35,7 @@ If you aren't familiar with the Segment Spec, take a look at the [Track method d ```js analytics.track('Login Button Clicked') ``` -Segment sends Track calls to HeadsUp as a `track` event. Use Track events to perform metric aggregations, such as how many times a user has logged into your application in the past 30 days. +Segment sends Track calls to HeadsUp as a `track` event. Use Track events to perform metric aggregations, such as how many times a user logged into your application in the past 30 days. ## Page