Skip to content

Commit 0e04f81

Browse files
amitj-humanicamitj-humanic
committed
added humanic.ai doc
1 parent a63d0a5 commit 0e04f81

File tree

1 file changed

+122
-0
lines changed
  • src/connections/destinations/catalog/humanic-ai

1 file changed

+122
-0
lines changed

‎src/connections/destinations/catalog/humanic-ai/index.md

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# 💥 Segment Partner Direct Destination Documentation Template
2+
3+
> Hi Partners 👋🏼
4+
>
5+
> 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.
6+
>
7+
> Here are the guidelines we want you to have in mind when writing out your documentation:
8+
>
9+
> - Be succinct and simple in your writing. Reduce text bloat where possible.
10+
> - Avoid 1st person language as it’s confusing for customers if they don’t know who wrote the docs (Segment or the Partner).
11+
> - Where pre-reading is required, hyperlink to other more generic parts of Segment’s (or your) documentation.
12+
>
13+
> - Screenshots/Images are generally discouraged unless absolutely necessary
14+
>
15+
> The below template intends to provide a standardized structure. To submit your documentation, complete the following steps:
16+
>
17+
> 1. Fork and clone the `segment-docs` repo locally
18+
> 2. Create a new branch (e.g., partner-name/destination)
19+
> 3. Create an `index.md` file in the following path `src/connections/destinations/catalog/humanic-ai/index.md
20+
> 4. Copy the template below into your `index.md` file, and edit it to be in line with how your integration operates
21+
> 5. Add, commit, and push your code, then submit a pull request to the `segment-docs` repo
22+
>
23+
> 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!
24+
>
25+
> If you have any questions in the meantime, please reach out to our team at [email protected].
26+
27+
## Template begins here...
28+
29+
---
30+
31+
## title: Humanic Destination
32+
33+
> Include a 1-2 sentence introduction to your company and the value it provides to customers - updating the name and hyperlink. Please leave the utm string unchanged.
34+
35+
[Humanic](https://humanic.ai/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is revolutionizing the CRM space to make it easier than ever for growing companies to maximize revenue from their existing users. Humanic is the industry's first PLG CRM for today’s modern revenue teams. With support from top industry veterans at DoorDash, Notion, Miro, Canvas, MailChimp and more - there's no better time explore what Humanic can offer your business!
36+
37+
Managing upwards of 1000+ active users can be an overwhelming task, and many CRMs struggle to keep up with the influx. If you need a reliable system that allows for user sorting based on payment or user activity, it's time to consider more robust solutions than traditional customer relationship management software. Read on for details on how the Humanic PLG CRM can help unlock revenue from your existing user base. To Sign up and explore right away [click here](https://humanic.ai/signup?utm_source=segmentio&utm_medium=docs&utm_campaign=partners).
38+
39+
> Update your company name and support email address.
40+
41+
This destination is maintained by Humanic. For any issues with the destination, [contact the Humanic Support team](mailto:[email protected]).
42+
43+
> Update your company name (x2) and support email address.
44+
45+
## Getting Started
46+
47+
> Do not remove this line. It will auto-populate the following information for your integration:
48+
49+
{% include content/connection-modes.md %}
50+
51+
> 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.
52+
53+
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
54+
2. Search for "Humanic" in the Destinations Catalog, and select the "Humanic" destination.
55+
3. Choose which Source should send data to the "Humanic" destination.
56+
4. Go to the [Humanic dashboard](https://dashboard.humanic.ai/dashboard/profile/){:target="\_blank"}, Go to the API Keys tab and generate an API key and copy it.
57+
5. Enter the "API Key" in the "Humanic" destination settings in Segment.
58+
59+
> For each of the following call types (Page, Screen, Identify, Track, Group), update:
60+
>
61+
> 1. Code snippet with relevant code sample including required traits or properties.
62+
> 2. Your integration name.
63+
> 3. What the corresponding call looks like within your platform (eg. Segment `page` call might be a `pageview` on your platform).
64+
> 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?)
65+
> 5. Any other important information for customer to note when sending through the events.
66+
67+
## Supported methods
68+
69+
Humanic.ai supports the following methods, as specified in the [Segment Spec](/docs/connections/spec).
70+
71+
### Page
72+
73+
Send [Page](/docs/connections/spec/page) calls to record which web pages users have visited. For example:
74+
75+
```js
76+
analytics.page("Pricing", {
77+
title: "Segment Pricing",
78+
url: "https://segment.com/pricing",
79+
path: "/pricing",
80+
referrer: "https://segment.com/warehouses",
81+
});
82+
```
83+
84+
Segment sends Page calls to Humanic.ai as a `pageview`.
85+
86+
### Screen
87+
88+
Send [Screen](/docs/connections/spec/screen) calls to ecord which mobile app screens users have viewed. For example:
89+
90+
```obj-c
91+
[[SEGAnalytics sharedAnalytics] screen:@"Home"
92+
properties:@{ @"Feed Type": @"private" }];
93+
```
94+
95+
Segment sends Screen calls to Humanic.ai as a `screenview`.
96+
97+
### Identify
98+
99+
Send [Identify](/docs/connections/spec/identify) calls to create new users or update existing users with new values. For example:
100+
101+
```js
102+
analytics.identify('userId123', {
103+
email: '[email protected]',
104+
});
105+
```
106+
107+
Segment sends Identify calls to Humanic.ai as an `identify` event.
108+
109+
### Track
110+
111+
Send [Track](/docs/connections/spec/track) calls to record user behavior in your app. For example:
112+
113+
```js
114+
analytics.track('Login Button Clicked');
115+
```
116+
117+
Segment sends Track calls to Humanic.ai as a `track` event.
118+
119+
---
120+
121+
> 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!
122+

0 commit comments

Comments
 (0)