Skip to content

Commit 1981b91

Browse files
committed
Merge branch 'develop' into DOC-493-IG
2 parents cb32198 + 9488619 commit 1981b91

File tree

36 files changed

+464
-96
lines changed

36 files changed

+464
-96
lines changed

.github/styles/Vocab/Docs/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ onboarding
7878
Optimizely
7979
performant
8080
Preact
81+
Selligent
8182
Shopify
8283
Skalin
8384
Smartly

src/_data/catalog/destination_categories.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination categories last updated 2022-06-23
2+
# destination categories last updated 2022-06-28
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

src/_data/catalog/destinations.yml

Lines changed: 148 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2022-06-23
2+
# destination data last updated 2022-06-28
33
items:
44
- id: 60b5d0a01f3726b85dc05aab
55
display_name: 2mee
@@ -27859,6 +27859,63 @@ items:
2785927859
label: API Key
2786027860
actions: []
2786127861
presets: []
27862+
- id: 6286930129cf5f85d889854f
27863+
display_name: Matcha
27864+
name: Matcha
27865+
slug: matcha
27866+
hidden: false
27867+
endpoints:
27868+
- us
27869+
regions:
27870+
- us
27871+
url: connections/destinations/catalog/matcha
27872+
previous_names:
27873+
- Matcha
27874+
website: https://www.matcha.co
27875+
status: PUBLIC_BETA
27876+
categories:
27877+
- Attribution
27878+
- CRM
27879+
- Performance Monitoring
27880+
- Raw Data
27881+
logo:
27882+
url: >-
27883+
https://public-segment-devcenter-production.s3.amazonaws.com/14c926bc-b30a-4ca0-a251-3667f20677fc.svg
27884+
mark:
27885+
url: >-
27886+
https://public-segment-devcenter-production.s3.amazonaws.com/a7b7f38a-7c9a-495a-8acd-4c1d6639c5fa.svg
27887+
methods:
27888+
track: true
27889+
identify: true
27890+
group: false
27891+
alias: false
27892+
page: true
27893+
platforms:
27894+
browser: true
27895+
mobile: true
27896+
server: true
27897+
components: []
27898+
browserUnbundlingSupported: false
27899+
browserUnbundlingPublic: false
27900+
replay: false
27901+
connection_modes:
27902+
device:
27903+
web: false
27904+
mobile: false
27905+
server: false
27906+
cloud:
27907+
web: false
27908+
mobile: false
27909+
server: false
27910+
settings:
27911+
- name: apiKey
27912+
type: string
27913+
defaultValue: ''
27914+
description: Ask your Account Manager for getting an API Key
27915+
required: true
27916+
label: API Key
27917+
actions: []
27918+
presets: []
2786227919
- id: 54521fda25e721e32a72eee7
2786327920
display_name: Matomo
2786427921
name: Matomo
@@ -30153,6 +30210,96 @@ items:
3015330210
label: Send experiment data to other tools as an identify call (not recommended)
3015430211
actions: []
3015530212
presets: []
30213+
- id: 625ed45387dd6603f5380424
30214+
display_name: Orb
30215+
name: Orb
30216+
slug: orb
30217+
hidden: false
30218+
endpoints:
30219+
- us
30220+
regions:
30221+
- us
30222+
url: connections/destinations/catalog/orb
30223+
previous_names:
30224+
- Orb
30225+
website: https://www.withorb.com
30226+
status: PUBLIC_BETA
30227+
categories:
30228+
- Analytics
30229+
logo:
30230+
url: >-
30231+
https://public-segment-devcenter-production.s3.amazonaws.com/cb93068e-6e55-4f0d-93a5-8daa8f481655.svg
30232+
mark:
30233+
url: >-
30234+
https://public-segment-devcenter-production.s3.amazonaws.com/f03533a8-430e-48fd-befb-4c479fa2b54c.svg
30235+
methods:
30236+
track: true
30237+
identify: false
30238+
group: false
30239+
alias: false
30240+
page: false
30241+
platforms:
30242+
browser: true
30243+
mobile: true
30244+
server: true
30245+
components: []
30246+
browserUnbundlingSupported: false
30247+
browserUnbundlingPublic: false
30248+
replay: false
30249+
connection_modes:
30250+
device:
30251+
web: false
30252+
mobile: false
30253+
server: false
30254+
cloud:
30255+
web: false
30256+
mobile: false
30257+
server: false
30258+
settings:
30259+
- name: apiKey
30260+
type: string
30261+
defaultValue: ''
30262+
description: 'You can generate or reuse an existing API key setup from the Orb webapp. '
30263+
required: true
30264+
label: API Key
30265+
- name: eventNameField
30266+
type: string
30267+
defaultValue: ''
30268+
description: >-
30269+
Optionally specify the key in your Segment event which signifies the name
30270+
of the action, which is mapped to `event_name` in Orb. By default, Orb
30271+
will use the value of "event".
30272+
required: true
30273+
label: Event name field
30274+
- name: externalCustomerIdField
30275+
type: string
30276+
defaultValue: ''
30277+
description: >-
30278+
Specify the key in your Segment event that identifies your user. This will
30279+
be used as the "external_customer_id" for the Orb event.
30280+
required: true
30281+
label: External customer ID field
30282+
- name: idempotencyKeyField
30283+
type: string
30284+
defaultValue: ''
30285+
description: >-
30286+
Optionally specify the key in your Segment event which uniquely identifies
30287+
this event. This is mapped to "idempotency_key" in Orb. By default, Orb
30288+
will use the value of "messageId".
30289+
required: true
30290+
label: Idempotency key field
30291+
- name: propertiesMappingFields
30292+
type: text-map
30293+
defaultValue: {}
30294+
description: >-
30295+
Map your track spec property keys from Segment to your desired event spec
30296+
for Orb. If a mapping is not specified, the key will be dropped from the
30297+
event before ingestion to avoid ingesting unwanted or sensitive data. All
30298+
keys and values in this field should be strings.
30299+
required: true
30300+
label: Properties mapping fields
30301+
actions: []
30302+
presets: []
3015630303
- id: 54521fd925e721e32a72eee1
3015730304
display_name: Pardot
3015830305
name: Pardot

src/_data/catalog/regional-supported.yml

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL
2-
# Last updated 2022-06-23
2+
# Last updated 2022-06-28
33
warehouses:
44
- id: WcjBCzUGff
55
display_name: Azure SQL Data Warehouse
@@ -372,6 +372,14 @@ sources:
372372
endpoints:
373373
- us
374374
- eu
375+
- id: V2kq0X7vYy
376+
display_name: Jebbit
377+
slug: jebbit
378+
url: connections/sources/catalog/cloud-apps/jebbit
379+
regions:
380+
- us
381+
endpoints:
382+
- us
375383
- id: EfKbe2yt0J
376384
display_name: Klaviyo
377385
slug: klaviyo
@@ -2580,6 +2588,14 @@ destinations:
25802588
- eu
25812589
endpoints:
25822590
- us
2591+
- id: 6286930129cf5f85d889854f
2592+
display_name: Matcha
2593+
slug: matcha
2594+
url: connections/destinations/catalog/matcha
2595+
regions:
2596+
- us
2597+
endpoints:
2598+
- us
25832599
- id: 54521fda25e721e32a72eee7
25842600
display_name: Matomo
25852601
slug: matomo
@@ -2814,6 +2830,14 @@ destinations:
28142830
- eu
28152831
endpoints:
28162832
- us
2833+
- id: 625ed45387dd6603f5380424
2834+
display_name: Orb
2835+
slug: orb
2836+
url: connections/destinations/catalog/orb
2837+
regions:
2838+
- us
2839+
endpoints:
2840+
- us
28172841
- id: 54521fd925e721e32a72eee1
28182842
display_name: Pardot
28192843
slug: pardot

src/_data/catalog/source_categories.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# source cateogries last updated 2022-06-23
2+
# source cateogries last updated 2022-06-28
33
items:
44
- display_name: A/B Testing
55
slug: a-b-testing

src/_data/catalog/sources.yml

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# sources last updated 2022-06-23
2+
# sources last updated 2022-06-28
33
items:
44
- id: 8HWbgPTt3k
55
display_name: .NET
@@ -657,6 +657,23 @@ items:
657657
url: https://cdn.filepicker.io/api/file/aRgo4XJQZausZxD4gZQq
658658
categories:
659659
- Website
660+
- id: V2kq0X7vYy
661+
display_name: Jebbit
662+
isCloudEventSource: true
663+
slug: jebbit
664+
url: connections/sources/catalog/cloud-apps/jebbit
665+
hidden: false
666+
regions:
667+
- us
668+
endpoints:
669+
- us
670+
source_type: cloud-app
671+
description: This is the description for Jebbit
672+
logo:
673+
url: >-
674+
https://public-segment-devcenter-production.s3.amazonaws.com/5f0ee774-1e09-476f-8e96-3bc549e09f5b.svg
675+
categories:
676+
- Surveys
660677
- id: EfKbe2yt0J
661678
display_name: Klaviyo
662679
isCloudEventSource: true
@@ -1404,7 +1421,7 @@ items:
14041421
programs.
14051422
logo:
14061423
url: >-
1407-
https://public-segment-devcenter-production.s3.amazonaws.com/8d5c27f3-2190-4159-930e-ef14a79e5de6.svg
1424+
https://public-segment-devcenter-production.s3.amazonaws.com/4cfb2d0e-5c17-4d16-bdb6-2a486fbb743f.svg
14081425
categories:
14091426
- Learning Management System
14101427
- id: wcssVcPJrc

src/connections/destinations/catalog/actions-metronome/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ hide-boilerplate: true
44
id: 61a8032ea5f157ee37a720be
55
redirect_from:
66
- '/connections/destinations/catalog/vendor-metronome'
7+
- '/connections/destinations/catalog/metronome-actions'
78
---
89
{% include content/plan-grid.md name="actions" %}
910

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ analytics.identify('su3r73', {
8989

9090
When you call Identify, Segment creates or updates the user in Intercom using their [Users API](https://developers.intercom.com/reference#users). Segment does not currently support creation of leads.
9191

92-
*Note:* Intercom only associates Track events with known users, an Identify call with a `userId` is required before Track events are associated properly. Our bundled mobile SDK's also require that `identify` be called prior to `track`, but accepts setting an unknown user in Intercom using the `anonymousId`.
92+
*Note:* Intercom only associates Track events with known users. An Identify call with a `userId` is required before Track events are associated properly. Segment's bundled mobile SDKs also require that `identify` be called prior to `track`, but accepts setting an unknown user in Intercom using the `anonymousId`.
9393

9494
Keep reading for more information about the Identify call depending on the source type you send it from.
9595

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,45 @@
11
---
2-
title: 'Metronome (Actions) Destination'
3-
hidden: true
2+
title: Metronome (Actions) Destination
3+
hide-boilerplate: true
44
id: 61a8032ea5f157ee37a720be
5-
published: false
5+
redirect_from:
6+
- '/connections/destinations/catalog/vendor-metronome'
7+
- '/connections/destinations/catalog/actions-metronome'
68
---
9+
{% include content/plan-grid.md name="actions" %}
10+
11+
[Metronome](https://www.metronome.com){:target="_blank"} helps software companies launch, iterate, and scale their business models with billing infrastructure that works at any size and stage. With Metronome, your team can set up a world-class billing infrastructure with minimal time and investment.
12+
13+
Metronome also enables product-led growth with a consistent source of truth for use and billing. Freely experiment with pricing and packaging and put iteration directly in the hands of your Product team.
14+
15+
## Getting Started
16+
17+
1. From the Segment web app, click **Catalog**, then click **Destinations**
18+
2. Search for **Metronome (Actions)** within the Destinations Catalog and select **Metronome (Actions)**
19+
3. Click **Configure Metronome (Actions)**.
20+
4. Select the source you’d like to connect to and give the destination a name.
21+
5. Enter your Metronome API Token into the Segment Connection Settings UI (save changes).
22+
23+
{% include components/actions-fields.html %}
24+
25+
26+
## Mapping events to Metronome
27+
28+
Map Segment events to the [Metronome event format](https://docs.metronome.com/getting-usage-data-into-metronome/overview/){:target="_blank"}. Metronome requires the five following fields:
29+
30+
Field | Type | Description
31+
----- | ---- | ------------
32+
`transaction_id` | (string) | The unique identifier for each event.
33+
`customer_id` | (string) | Represents which customer in Metronome the event applies to.
34+
`timestamp` | (string) | This is when the event happened in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt){:target="_blank"}.
35+
`event_type` | (string) | This is the kind of event. For example, `page_view` or `cpu_used`.
36+
`properties` | (object) | The key/value pairs with details of the event.
37+
38+
## Benefits of Metronome (Actions)
39+
Metronome (Actions) provides the following benefits:
40+
41+
- **Streamlined Configuration**. Configure connection details on a per-event basis, rather than for the destination as a whole.
42+
43+
- **Easy access to data**. The event variables picker shows you all the available data from the event you use to test the Trigger. Variables are clearly labeled to ensure they stand out from other text and markup.
44+
45+
- **Clear mapping of data** Actions-based destinations enable you to define the mapping between the data Segment receives from your source and the data Segment sends to Metronome.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Orb Destination
3+
id: 625ed45387dd6603f5380424
4+
beta: true
5+
---
6+
[Orb](https://www.withorb.com/) provides scalable, reliable, and flexible billing infrastructure for usage based revenue models at companies of all sizes.
7+
8+
Orb maintains this destination. For any issues with the destination, [contact the Orb support team](mailto:[email protected]).
9+
10+
## Getting started
11+
12+
{% include content/connection-modes.md %}
13+
14+
1. Navigate to **Connections** and click **Add Destination** in the Segment app.
15+
2. Search for *Orb* in the Destinations Catalog, and select the **Orb** destination.
16+
3. Choose which Source should send data to the Orb destination.
17+
4. Go to the [Orb dashboard](https://app.billwithorb.com) and create a new API key from the configuration page. Segment recommends you to create a new API key for this integration rather than using an existing one.
18+
5. Enter the **API Key** in the Orb destination settings in Segment.
19+
6. Enter the connection settings for the external customer ID and properties mapping fields.
20+
21+
## Supported methods
22+
23+
Orb currently supports track calls, as specified in the [Segment Spec](/docs/connections/spec).
24+
25+
### Track
26+
27+
Use [Track](/docs/connections/spec/track) calls to automatically send usage events based on your customer's interactions with your application. Any Segment track call will be ingested through [Orb's ingestion pipeline](https://docs.withorb.com/docs/orb-docs/event-ingestion) and usage information will be used to calculate billable totals. For example:
28+
```js
29+
analytics.track({
30+
event: "payment_confirmed",
31+
userId: "external_customer_id",
32+
properties: {
33+
amount: 100.00,
34+
currency: "USD",
35+
confirmation_time: "2022-05-11T21:33:13.1652304793Z"
36+
}
37+
});
38+
```
39+
Similar to Segment, Orb supports a flexible event schema in the `properties` dictionary, which should be non-null and not contain nested objects. Within Orb, you can configure metrics by filtering and aggregating events. When you configure the Orb destination, you are required to specify a mapping of keys from the original Segment event to Orb’s usage event. You can also configure keys corresponding to Orb’s required fields such as `event_name` , `idempotency_key`, and `external_customer_id`.
40+
41+
Events ingested through the track spec are available on the Orb admin dashboard, specifically on the [Events page](https://app.billwithorb.com/events).

0 commit comments

Comments
 (0)