Merge pull request #6251 from segmentio/develop

Release 24.12.1

Author: cmastr

src/_data/actions/braze-cloud.yml

@@ -173,7 +173,7 @@ actions:
       description: Set to true to use the Braze API in "Update Only" mode.
       default: false
   - action: Track Purchase
-    blurb: Track Purchase sends Braze a Track Purchase call when the destination recieves any event that matches the specified name.
+    blurb: Track Purchase sends Braze a Track Purchase call when the destination receives any event that matches the specified name.
     fields:
     - name: Time
       description: The timestamp of when the event occured.

src/_data/actions/braze-web.yml

@@ -221,7 +221,7 @@ actions:
       description: Set to true to use the Braze API in "Update Only" mode.
       default: false
   - action: Track Purchase
-    blurb: Track Purchase sends Braze a Track Purchase call when the destination recieves any event named `Order Completed`.
+    blurb: Track Purchase sends Braze a Track Purchase call when the destination receives any event named `Order Completed`.
     fields:
     - name: Time
       description: The timestamp of when the event occured.

src/_data/catalog/destination_categories.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
-# destination categories last updated 2024-03-14 
+# destination categories last updated 2024-03-19 
 items:
 - display_name: A/B Testing
   slug: a-b-testing

src/_data/catalog/destinations.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
-# destination data last updated 2024-03-14 
+# destination data last updated 2024-03-19 
 items:
 - id: 637e8d185e2dec264895ea89
   display_name: 1Flow
@@ -60154,6 +60154,63 @@ items:
     label: Events
   actions: []
   presets: []
+- id: 65e8b496eec9c40dbccbf749
+  display_name: MetricStory
+  name: MetricStory
+  slug: metricstory
+  hidden: false
+  endpoints:
+  - US
+  regions:
+  - us-west-2
+  - eu-west-1
+  url: connections/destinations/catalog/metricstory
+  previous_names:
+  - MetricStory
+  website: http://www.metricstory.ai
+  status: PUBLIC_BETA
+  categories:
+  - Analytics
+  - Analytics
+  logo:
+    url: https://cdn-devcenter.segment.com/e1a77986-7c66-45d2-a7b7-a850dee73f0a.svg
+  mark:
+    url: https://cdn-devcenter.segment.com/68c979e1-b86a-4317-bd82-9a821aabf0b1.svg
+  methods:
+    track: false
+    identify: false
+    group: false
+    alias: false
+    screen: false
+    page: false
+  platforms:
+    browser: true
+    mobile: true
+    server: true
+    warehouse: false
+    cloudAppObject: false
+  components: []
+  browserUnbundlingSupported: false
+  browserUnbundlingPublic: false
+  replay: false
+  connection_modes:
+    device:
+      web: false
+      mobile: false
+      server: false
+    cloud:
+      web: true
+      mobile: true
+      server: true
+  settings:
+  - name: apiKey
+    type: string
+    defaultValue: ''
+    description: Your MetricStory API key
+    required: true
+    label: API Key
+  actions: []
+  presets: []
 - id: 61a8032ea5f157ee37a720be
   display_name: Metronome (Actions)
   name: Metronome (Actions)

src/_data/catalog/destinations_private.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
-# destination data last updated 2024-03-14 
+# destination data last updated 2024-03-19 
 items:
   - id: 54521fd925e721e32a72eee1
     display_name: Pardot

src/_data/catalog/regional-supported.yml

@@ -98,7 +98,7 @@ sources:
       - us
   - id: xNpohElkX2
     display_name: Azure
-    hidden: true
+    hidden: false
     slug: azure
     url: connections/sources/catalog/cloud-apps/azure
     regions:
@@ -957,6 +957,15 @@ sources:
       - us
     endpoints:
       - us
+  - id: OyAdFUfMz9
+    display_name: Synap
+    hidden: false
+    slug: synap
+    url: connections/sources/catalog/cloud-apps/synap
+    regions:
+      - us
+    endpoints:
+      - us
   - id: 43bb279b7
     display_name: Twilio
     hidden: false

src/_data/catalog/source_categories.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
-# source categories last updated 2024-03-14 
+# source categories last updated 2024-03-19 
 items:
   - display_name: A/B Testing
     slug: a-b-testing

src/_data/catalog/sources.yml

@@ -1,5 +1,5 @@
 # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
-# sources last updated 2024-03-14 
+# sources last updated 2024-03-19 
 items:
   - id: 8HWbgPTt3k
     display_name: .NET
@@ -1964,6 +1964,24 @@ items:
     categories:
       - Surveys
       - Customer Success
+  - id: OyAdFUfMz9
+    display_name: Synap
+    isCloudEventSource: true
+    slug: synap
+    url: connections/sources/catalog/cloud-apps/synap
+    hidden: false
+    regions:
+      - us
+    endpoints:
+      - us
+    source_type: cloud-app
+    description: Online learning and assessments
+    logo:
+      url: >-
+        https://cdn-devcenter.segment.com/685e8ea7-1bd7-4907-ae02-05e2ce099134.svg
+    categories:
+      - Learning Management System
+      - Performance Monitoring
   - id: 43bb279b7
     display_name: Twilio
     isCloudEventSource: false

src/connections/destinations/catalog/actions-google-sheets/index.md

@@ -38,3 +38,7 @@ The Record Identifier mapping is used to make a distinction between adding a new
 ### How do I define the columns in my spreadsheet?
 
 The Fields mapping controls which fields in your model will be written as columns. Input the desired column name(s) on the left, and select the data variable that will populate the value for that column on the right. Please note, at least one field must be configured to send data to Google Sheets otherwise no columns will be created or synced.
+
+### How are columns formatted when synced to my spreadsheet?
+
+When syncing data to Google Sheets, the columns will be arranged alphabetically, based on the names defined in the Fields mapping.

src/connections/destinations/catalog/autopilotapp/index.md

@@ -13,7 +13,8 @@ This destination is maintained by Ortto. For any issues with the destination, [c
 
 ## Getting Started
 
-
+> info ""
+> You need Workspace Owner permissions to create the Ortto destination through OAuth on Ortto's website.
 
 1. From the Destinations catalog page in the Segment App, click **Add Destination**.
 2. Search for "Ortto" in the Destinations Catalog, and select the "Ortto" destination.
@@ -52,4 +53,4 @@ analytics.track('Login Button Clicked', {
 });
 ```
 
-Segment sends Track calls to Ortto as a `track` event.
+Segment sends Track calls to Ortto as a `track` event.

src/connections/destinations/catalog/braze/index.md

@@ -353,7 +353,7 @@ The `inAppMessages` parameter will be an array of [`appboy.ab.InAppMessage`](htt
     // When you get the push token
     String receivedToken;
 
-    appboyPushToken = recievedToken;
+    appboyPushToken = receivedToken;
     if (appboyInitialized) {
       Appboy.getInstance(getContext()).registerAppboyPushMessages(appboyPushToken);
     }

src/connections/destinations/catalog/google-analytics/index.md

@@ -839,7 +839,7 @@ To enable user deletion for Google Universal Analytics:
 2. Authenticate your Google Universal Analytics account using OAuth.
 
 > info ""
-> **NOTE:** Segment supports user deletion for Google Universal Analytics in Universal Analytics and not Classic Analytics. You can send user deletion requests using a `userId` through the Privacy Tool. This means you must  have the User-Id feature enabled in your Google Universal Analytics Property within the your Google Universal Analytics dashboard and have Segment sending your Property `userIds` by enabling the setting **Send User-ID to GA**.
+> **NOTE:** Segment supports user deletion for Google Universal Analytics in Universal Analytics and not Classic Analytics. You can send user deletion requests using a `userId` through the Privacy Tool. This means you must  have the User-Id feature enabled in your Google Universal Analytics Property within your Google Universal Analytics dashboard and have Segment sending your Property `userIds` by enabling the setting **Send User-ID to GA**.
 
 
 

src/connections/destinations/catalog/metricstory/index.md

@@ -0,0 +1,43 @@
+---
+title: MetricStory Destination
+id: 65e8b496eec9c40dbccbf749
+beta: true
+---
+
+[MetricStory](https://www.metricstory.ai){:target="_blank”} lets you run AI on your product analytics, create and generate charts, and analyze data in minutes.
+
+MetricStoryAI maintains this destination. For any issues with the destination, contact the [MetricStory support team]([email protected]).
+
+## Getting started
+1. From the Destination catalog page in the Segment app, search for MetricStory.
+2. Select and click **Add Destination**.
+3. Select an existing source to connect to.
+4. Go to the [API Keys](https://www.metricstory.ai/account/apikeys){:target="_blank"} page in MetricStory.ai.
+5. Copy your API key
+6. Enter the API key in the destination settings in Segment.
+
+## Supported methods
+MetricStory supports the following methods, as specified in the [Segment Spec](/docs/connections/spec).
+
+### Page
+The Page method triggers a call to Segment's `page` method which lets users query drop off in the funnel.
+
+```js
+analytics.page()
+```
+
+### Identify
+The Identify call identifies users for tracking purposes within MetricStory. MetricStory uses this data to group users together in cohorts, track individual user data, and more.
+
+```js
+analytics.identify('userId123', {
+  email: '[email protected]'
+});
+```
+
+### Track
+MetricStory uses this data to understand how users are interacting with apps and lets users query data with AI through the events.
+
+```js
+analytics.track('Login Button Clicked')
+```

src/connections/destinations/catalog/mixpanel/index.md

@@ -496,6 +496,14 @@ If you're testing in Xcode remember you must first background the app, then the
 In Device-mode, when a `distinct_id` is present in the browser, it is automatically sent to Mixpanel. In Cloud-mode, the `distinct_id` is set to Segment's `userId` if one is present. If there is no `userId` on the payload, `anonymousId` is set instead.
 
 
+### Insert ID
+
+`$insert_id` is only available for cloud events. For the Mixpanel (Legacy) destination, Segment generates `$insert_id` from the messageId, event name, and Mixpanel namespace constant using the [uuidv5](https://developer.hashicorp.com/terraform/language/functions/uuidv5) function:
+```javascript
+const insertId = uuidv5(`${messageId}:${projectId}:${eventName}`, MIXPANEL_NAMESPACE)
+```
+
+
 ### IP
 
 If an `ip` property is passed to Mixpanel, the value will be interpreted as the IP address of the request and therefore automatically parsed into Mixpanel geolocation properties (City, Country, Region). After that IP address has been parsed, they will throw out the IP address and only hold onto those resulting geolocation properties. As such, if you want to display an IP address as a property within the Mixpanel UI or within raw data, you will simply want to slightly modify the naming convention for that property.

src/connections/destinations/catalog/split/index.md

@@ -94,4 +94,4 @@ Each event may have a `value` field which you would like to use in Split metric
 
 If you would not like Split to receive `track` calls, you can configure in your integration settings in Split.
 
-_**NOTE:** Split currently does not capture the properties of the your track events. The Split team is currently working to accept these properties for use in creating metrics in Split._
+_**NOTE:** Split currently does not capture the properties of your track events. The Split team is currently working to accept these properties for use in creating metrics in Split._

src/connections/sources/catalog/cloud-apps/engage-events/index.md

@@ -87,7 +87,7 @@ SendGrid powers Engage email delivery. For more information, view [SendGrid's Ev
 
 | Event                        | Definition                                            |
 | ---------------------------- | ----------------------------------------------------- |
-| WhatsApp Message Queued      | The WhatsApp message creation requested was recieved. |
+| WhatsApp Message Queued      | The WhatsApp message creation requested was received. |
 | WhatsApp Message Accepted    | The WhatsApp message creation request was accepted.   |
 | WhatsApp Message Sending     | The WhatsApp message is being sent.                   |
 | WhatsApp Message Sent        | The WhatsApp message was successfully sent.           |

src/connections/sources/catalog/cloud-apps/freshchat/index.md

@@ -20,7 +20,7 @@ Before you start, make sure that you have admin rights in Freshchat and [Workspa
 5. Copy the Write key from the Segment UI to use in Freshchat.
 6. Log in to your Freshchat account.
 7. In Freshchat, navigate to Admin → Marketplace Apps → Segment Integration.
-8. Paste the your Segment write key and click **Authenticate account** to connect.
+8. Paste your Segment write key and click **Authenticate account** to connect.
 9. After your account is authenticated, select one or more of the following events to send to Segment:
     - On Agent Activity Create
     - On Conversation Create

src/connections/sources/catalog/cloud-apps/synap/index.md

@@ -0,0 +1,89 @@
+---
+title: Synap Source
+id: OyAdFUfMz9
+beta: true
+---
+
+[Synap](https://synap.ac){:target="_blank”} is an online exam platform specialising in the delivery of high stakes exams, assessments and online learning. Synap is used by a wide range of companies and educational institutions to deliver high quality, robust assessments.
+
+This source is maintained by Synap. For any issues with the source, contact Synap via the live chat widget available on your portal, or get in touch with your account manager. Synap also provides more [detailed documentation on their website](https://academy.synap.ac/doc/integrations/segment){:target="_blank”} with specific guides and best practices.
+
+## Getting started
+
+1. From your workspace's Sources page, click **Add source**.
+
+2. Search for and select Synap.
+
+3. Copy the Write key from the Segment UI.
+
+4. Login to your Synap portal as an admin, and go to `/portal-dashboard/settings/integrations`. To navigate to this page via the UI, first click on the 'gears' icon near the bottom left hand side of the screen, then look for the Integrations menu item.
+
+5. Paste your write key into the Segment Write Key box and click **Save** - this verifies and saves your API key.
+
+## Stream
+
+Synap uses their stream Source component to send Segment event data. On the client-side, this source uses Segment's Identify and Page events. On the server-side, it uses Identify and Track events. These events are then available in any Segment destination that accepts client or server-side events and available in a schema in your data warehouse that you can query using SQL.
+
+Synap identifies users based on their Synap User ID, which is sent as the userId in Segment events.
+
+## Events
+
+The table below lists events that Synap sends to Segment. These events appear as tables in your warehouse, and as regular events in other destinations. Synap includes the userId, if available.
+
+| Event Name             | Description                                                       |
+| ---------------------- | ----------------------------------------------------------------- |
+| Began Test             | User starts a test                                                |
+| Submitted Test         | User finishes ('submits') a test (may or may not require marking) |
+| Completed Test         | When a Test has been 'completed' (including marking)              |
+| Collection Item Viewed | User views a Collection Item                                      |
+| User Registered        | User registered an Account                                        |
+| Assignment Started     | User starts an Assignment                                         |
+| Exam User Registered   | User is enrolled for an Exam                                      |
+| User Logged In         | User explicitly logged in to Synap                                |
+| User Session Restored  | User opened Synap after a period of in activity                   |
+
+To find the list of properties associated with the events, please refer to the [Synap Segment Documentation](https://academy.synap.ac/doc/integrations/segment){:target="_blank”}. Some of the events, notably those related to Test and Question submission, have relatively large payloads. You might want to review the [Synap Test and Question Analytics Schemas](https://academy.synap.ac/doc/integrations/segment/test-and-question-analytics){:target="_blank"} before tracking these events. 
+
+## Identify
+
+Synap sends an identify() message to Segment which consists of the userId and the user traits.
+
+| Field   | Type   | Description                                                                           |
+| ------- | ------ | ------------------------------------------------------------------------------------- |
+| userId  | string | Unique identifier for the user in Synap                                               |
+| context | object | User [context](https://segment.com/docs/connections/spec/common/#context)             |
+| traits  | object | Custom [traits](https://segment.com/docs/connections/spec/common/#traits) of the user |
+
+### Identify traits
+
+| Name                   | Type                                | Description                                                             |
+| ---------------------- | ----------------------------------- | ----------------------------------------------------------------------- |
+| createdAt              | date                                | The date this user's account was created                                |
+| email                  | string                              | The user's email address                                                |
+| emailVerified          | boolean                             | Whether or not the user has verified their email address                |
+| firstName              | string                              | The user's first name                                                   |
+| lastName               | string                              | The user's last name                                                    |
+| marketingEmailsConsent | "removed", "pending" or "confirmed" | Enumeration representing the user's consent to receive marketing emails |
+| name                   | string                              | The user's full name                                                    |
+| profilePicture         | string                              | a URL pointing to the user's profile picture, if provided               |
+
+
+## Page
+
+Page calls include the page path and unique URL.
+
+| Name   | Type   | Description                              |
+| ------ | ------ | ---------------------------------------- |
+| name   | string | The name of the page                     |
+| path   | string | The relative path to the page            |
+| search | string | Any query string parameters from the URL |
+| title  | string | The title of the page                    |
+| url    | string | The full URL of the page                 |
+
+## Adding destinations
+
+Now that your source is set up, you can connect it to destinations.
+
+Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the Event Delivery tool, and refer to the destination docs for each tool for troubleshooting.
+
+If there are any issues with how the events are arriving to Segment, contact the Synap support team via the live chat widget which is available to all Admin users of your portal.

src/connections/sources/catalog/libraries/mobile/apple/index.md

@@ -159,6 +159,9 @@ Analytics for Swift is built with extensibility in mind. Use the tools list belo
 - [Destination Filters](/docs/connections/sources/catalog/libraries/mobile/swift/swift-destination-filters)
 - [Code samples](/docs/connections/sources/catalog/libraries/mobile/swift/swift-samples)
 
+## Proxying events
+If you proxy your events through the `apiHost` config option, you must forward the batched events to `https://api.segment.io/v1/b`. The `https://api.segment.io/v1/batch` endpoint is reserved for events arriving from server-side sending, and proxying to that endpoint for your mobile events may result in unexpected behavior.
+
 > warning ""
 > If you are using the Analytics iOS (Classic) SDK, you can find [the documentation here](/docs/connections/sources/catalog/libraries/mobile/ios). Many of the features available in the Analytics-Swift SDK are not available in the Analytics iOS (Classic) SDK.