Segment Documentation
# 💫 Segment Partner Destination Documentation Template

> Hi Partners 👋🏼
>
> Welcome to Segment - glad to have you onboard! This doc serves as a guideline for your team to create best-in-class documentation alongside your amazing product.
>
> At Segment, we believe that documentation is crucial in delivering the best experience for our mutual customers so we want to think with the following mindset:
>
>+ Be succinct and simple in your writing. Reduce text bloat where possible.
>+ Avoid 1st person language as it’s confusing for customers if they don’t know who wrote the docs (Segment or the Partner).
>+ Use the active voice - instead of "The destination will do this." write something like "The destination does this."
>+ Where pre-reading is required, hyperlink to other more generic parts of Segment’s (or your) documentation.
>
>+ Provide actionable code samples for each API method.
>
>+ If you would like to include screenshots, send the original image to us via [e-mail] with naming corresponding to where you've included it within the Markdown below. We prefer PNG images within 400px - 1200px. If you'd like to submit a GIF, keep under 15MB. Generally you should be able to write these out as text, so only use them when there's something really hard to explain.
>
> The below template intends to provide a standardized structure. Please **make a copy** of this template for editing and submit to the Segment team as a new note on [HackMD.io](https://hackmd.io/). You can view a sample doc as reference here: https://segment.com/docs/connections/destinations/catalog/clearbrain/.
>
> If a section does not apply to your integration, feel free to remove. Please don’t create separate sections unless absolutely necessary. In most cases, creating a H3 (###) sub-heading under an existing section is the best option!
>
> If you have any questions in the meantime, please reach out to our team at [e-mail].

---
Orb Destination
---
[Orb](https://www.withorb.com/) provides scalable, reliable, and flexible billing infrastructure for usage based revenue models at companies of all sizes.

This destination is maintained by Orb. For any issues with the destination, [Contact the orb support team](mailto:[e-mail]).

## Getting Started

> Do not remove this line. It will auto-populate the following information for your integration:

{% include content/connection-modes.md %}

> Include clear, succinct steps including hyperlinks to where customers can locate their API Key in your app. If there is an expected delay for a customer to see data flow into your integration, please make that explicit.

1. From the Destinations catalog page in the Segment App, click **Add Destination**.
2. Search for "Orb" in the Destinations Catalog, and select the "Orb" destination.
3. Choose which Source should send data to the "Orb" destination.
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.
5. Enter the "API Key" in the "Orb" destination settings in Segment.
6. Fill out the settings for properties mapping fields, external customer Id, Idempotency key (optional), and event name (optional).

<!--
> For each of the following call types (Page, Screen, Identify, Track, Group), update:
> 1. Code snippet with relevant code sample including required traits or properties.
> 2. Your integration name.
> 3. What the corresponding call looks like within your platform (eg. Segment `page` call might be a `pageview` on your platform).
> 4. It can be helpful to describe *where* data will appear (ie. Will `identify` calls appear within a Users dashboard as well as the Real-time dashboard of your platform?)
> 5. Any other important information for customer to note when sending through the events. -->

## Supported methods

Orb currently supports track calls, as specified in the [Segment Spec](/docs/connections/spec).

### Track
Send [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:

analytics.track({
  event: "payment_confirmed",
  userId: "external_customer_id",
  properties: {
    amount: 100.00,
    currency: "USD",
    confirmation_time: "2022-05-11T21:33:13.1652304793Z"
  }
});

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`.

Events ingested via the track spec here will be available on the Orb admin dashboard, specifically on the [Events page](https://app.billwithorb.com/events).

---

> Congratulations! 🎉 You’ve finished the documentation for your Segment integration. If there’s any additional information or nuance which did not fit in the above template and that you want to share with our mutual customers, feel free to include these as a separate section for us to review. If not, you may now submit this doc to our team via your designated Slack Channel and we’ll respond with updates when we publish it and your integration!