Merge pull request #1609 from segmentio/headsup-docs

HeadsUp AI docs

Author: pauljaeinyoo

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

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

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

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

src/connections/destinations/catalog/headsup-ai/index.md

@@ -0,0 +1,57 @@
+---
+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.
+
+This destination is maintained by HeadsUp. For any issues with the destination, [contact the HeadsUp AI Support team](mailto:[email protected]).
+
+## 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. Back in the Segment App, go back to the the HeadsUp AI Destination settings, and enter the "API Key".
+
+## 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: '[email protected]'
+});
+```
+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 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.