Skip to content

Commit 299a1da

Browse files
author
markzegarelli
committed
merge conflicts
2 parents 2e1c94d + 5e37368 commit 299a1da

File tree

28 files changed

+296
-179
lines changed

28 files changed

+296
-179
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Hubspot
5454
incrementality
5555
ios
5656
iOS
57+
Iterable
5758
Javadoc
5859
Javadocs
5960
Javascript
@@ -77,6 +78,7 @@ onboarding
7778
Optimizely
7879
performant
7980
Preact
81+
Selligent
8082
Shopify
8183
Skalin
8284
Smartly

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
title: Metronome (Actions) Destination
33
hide-boilerplate: true
44
id: 61a8032ea5f157ee37a720be
5-
redirect_from:
6-
- '/connections/destinations/catalog/vendor-metronome'
5+
hidden: true
76
---
87
{% include content/plan-grid.md name="actions" %}
98

@@ -14,10 +13,10 @@ Metronome also enables product-led growth with a consistent source of truth for
1413
## Getting Started
1514

1615
1. From the Segment web app, click **Catalog**, then click **Destinations**
17-
2. Search for **Metronome (Actions)** within the Destinations Catalog and select **Metronome (Actions)**
16+
2. Search for "Metronome (Actions)" within the Destinations Catalog and select **Metronome (Actions)**
1817
3. Click **Configure Metronome (Actions)**.
19-
4. Select the source you’d like to connect to and give the destination a name
20-
5. Enter your Metronome API Token into the Segment Connection Settings UI (save changes).
18+
4. Select the source you’d like to connect to and give the destination a name (for example, `Metronome Instance #1`).
19+
5. Enter your Metronome API Token on the **Settings** pane in the **API Token** box, and save changes.
2120

2221
{% include components/actions-fields.html %}
2322

@@ -41,4 +40,4 @@ Metronome (Actions) provides the following benefits:
4140

4241
- **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.
4342

44-
- **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.
43+
- **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: 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 fields listed below:
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: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,41 @@
11
---
2-
title: 'Orb Destination'
3-
hidden: true
2+
title: Orb Destination
43
id: 625ed45387dd6603f5380424
5-
published: false
64
beta: true
75
---
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).
22.7 KB
Loading
32.4 KB
Loading
28.5 KB
Loading
39.7 KB
Loading
12.5 KB
Loading
15.9 KB
Loading

0 commit comments

Comments
 (0)