You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/orb/index.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,18 +4,18 @@ id: 625ed45387dd6603f5380424
4
4
---
5
5
[Orb](https://www.withorb.com/) provides scalable, reliable, and flexible billing infrastructure for usage based revenue models at companies of all sizes.
6
6
7
-
This destination is maintained by Orb. For any issues with the destination, [Contact the Orb support team](mailto:[email protected]).
7
+
Orb maintains this destination. For any issues with the destination, [contact the Orb support team](mailto:[email protected]).
8
8
9
-
## Getting Started
9
+
## Getting started
10
10
11
11
{% include content/connection-modes.md %}
12
12
13
-
1.From the Destinations catalog page in the Segment App, click **Add Destination**.
14
-
2. Search for "Orb" in the Destinations Catalog, and select the "Orb" destination.
15
-
3. Choose which Source should send data to the "Orb" destination.
16
-
4. Go to the [Orb dashboard](https://app.billwithorb.com), create a new API key from the configuration's page or reuse an existing one. We recommend creating a new API key for this integration.
17
-
5. Enter the "API Key" in the "Orb" destination settings in Segment.
18
-
6.Fill out the settings for properties' mapping fields, external customer Id, Idempotency key (optional), and event name (optional).
13
+
1.Navigate to **Connections** and click **Add Destination** in the Segment app.
14
+
2. Search for *Orb* in the Destinations Catalog, and select the **Orb** destination.
15
+
3. Choose which Source should send data to the Orb destination.
16
+
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.
17
+
5. Enter the **API Key** in the Orb destination settings in Segment.
18
+
6.Enter the connection settings for the external customer ID and properties mapping fields.
19
19
20
20
## Supported methods
21
21
@@ -35,6 +35,6 @@ analytics.track({
35
35
}
36
36
});
37
37
```
38
-
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 will be required to specify a mapping of keys from the original Segment event to Orb’s usage event. You’ll also be able to configure keys corresponding to Orb’s required fields such as `event_name` , `idempotency_key`, and `external_customer_id`.
38
+
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`.
39
39
40
-
Events ingested via the track spec will be available on the Orb admin dashboard, specifically on the [Events page](https://app.billwithorb.com/events).
40
+
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