Skip to content

Commit 91d0a25

Browse files
authored
Merge pull request #3119 from segmentio/thomas/orb
add Orb destination documentation
2 parents 0c98ea0 + c9200b9 commit 91d0a25

File tree

1 file changed

+41
-0
lines changed
  • src/connections/destinations/catalog/orb

1 file changed

+41
-0
lines changed
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)