Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1flow-web actions #5769

Closed
wants to merge 6 commits into from
Closed

1flow-web actions #5769

wants to merge 6 commits into from

Conversation

namit1Flow
Copy link
Contributor

1Flow web actions doc,we are targeting on track and identify user.

@namit1Flow namit1Flow requested a review from a team as a code owner December 6, 2023 10:37
@namit1Flow namit1Flow requested review from forstisabella and removed request for a team December 6, 2023 10:37
@forstisabella forstisabella added the new-integration Added a new source or destination label Dec 6, 2023
@namit1Flow
Copy link
Contributor Author

Hi @forstisabella , @tcgilbert ,

Thanks for reviewing, I have fixed the above comments.
Also sorry for the previous comment.

Thanks

Copy link
Contributor

@forstisabella forstisabella left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few changes and we'll be good to go 🚀


The Segment 1Flow Destination allows you to get started with 1Flow and its core APIs. You can:
1. Automatically install the [1Flow SDK](https://docs.1flow.ai/install-sdk/javascript){:target="_blank"}.
2. Automatically send [user attributes](https://docs.1flow.ai/install-sdk/javascript#de21ec0a453d443b88ca4bc1b12dc6bf){:target="_blank"} to 1Flow by connecting your Segment `identify` calls with 1Flow's own Identify API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Automatically send [user attributes](https://docs.1flow.ai/install-sdk/javascript#de21ec0a453d443b88ca4bc1b12dc6bf){:target="_blank"} to 1Flow by connecting your Segment `identify` calls with 1Flow's own Identify API.
2. Automatically send [user attributes](https://docs.1flow.ai/install-sdk/javascript#de21ec0a453d443b88ca4bc1b12dc6bf){:target="_blank"} to 1Flow by connecting your Segment Identify calls with 1Flow's Identify API.

The Segment 1Flow Destination allows you to get started with 1Flow and its core APIs. You can:
1. Automatically install the [1Flow SDK](https://docs.1flow.ai/install-sdk/javascript){:target="_blank"}.
2. Automatically send [user attributes](https://docs.1flow.ai/install-sdk/javascript#de21ec0a453d443b88ca4bc1b12dc6bf){:target="_blank"} to 1Flow by connecting your Segment `identify` calls with 1Flow's own Identify API.
3. Automatically send [custom events](https://docs.1flow.ai/install-sdk/javascript#d19201d97efa4ea4b81be6a351709332){:target="_blank"} to 1Flow by connecting your Segment `track` calls with 1Flow's own Events API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. Automatically send [custom events](https://docs.1flow.ai/install-sdk/javascript#d19201d97efa4ea4b81be6a351709332){:target="_blank"} to 1Flow by connecting your Segment `track` calls with 1Flow's own Events API.
3. Automatically send [custom events](https://docs.1flow.ai/install-sdk/javascript#d19201d97efa4ea4b81be6a351709332){:target="_blank"} to 1Flow by connecting your Segment Track calls with 1Flow's Events API.


## Identify

The 1Flow destination will automatically ingest a User ID and any values sent over your Identify spec as [traits](https://docs.1flow.ai/install-sdk/javascript#de21ec0a453d443b88ca4bc1b12dc6bf), as long as session capture is enabled in 1Flow.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The 1Flow destination will automatically ingest a User ID and any values sent over your Identify spec as [traits](https://docs.1flow.ai/install-sdk/javascript#de21ec0a453d443b88ca4bc1b12dc6bf), as long as session capture is enabled in 1Flow.
The 1Flow destination will automatically ingest a User ID and any values sent over your Identify spec as [traits](https://docs.1flow.ai/install-sdk/javascript#de21ec0a453d443b88ca4bc1b12dc6bf){:target="_blank"}, as long as session capture is enabled in 1Flow.


## Track

The 1Flow destination automatically ingests any user actions tracked over your Track spec as [events](https://docs.1flow.ai/install-sdk/javascript#d19201d97efa4ea4b81be6a351709332), as long as session capture is enabled in 1Flow.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The 1Flow destination automatically ingests any user actions tracked over your Track spec as [events](https://docs.1flow.ai/install-sdk/javascript#d19201d97efa4ea4b81be6a351709332), as long as session capture is enabled in 1Flow.
The 1Flow destination automatically ingests any user actions tracked over your Track spec as [events](https://docs.1flow.ai/install-sdk/javascript#d19201d97efa4ea4b81be6a351709332){:target="_blank"}, as long as session capture is enabled in 1Flow.

Comment on lines 38 to 47
### Settings

##### SETTING

API KEY
(required)

##### DESCRIPTION

string. Your API key can be found in your 1Flow dashboard -> Settings -> Project Settings page.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The settings that you provide Segment when you built this destination are autogenerated at the end of this file - you don't need to hardcode them!

Suggested change
### Settings
##### SETTING
API KEY
(required)
##### DESCRIPTION
string. Your API key can be found in your 1Flow dashboard -> Settings -> Project Settings page.

@@ -0,0 +1,47 @@
---
title: 1Flow Web Actions
Copy link
Contributor

@forstisabella forstisabella Dec 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: 1Flow Web Actions
title: 1Flow Web (Actions) Destination

@namit1Flow
Copy link
Contributor Author

Hi @forstisabella , @tcgilbert ,

Thank you for reviewing; I have made the suggested change.

@tcgilbert
Copy link
Contributor

hi @namit1Flow and @forstisabella - apologies for missing this, but it appears that you did in fact submit docs for this destination previously.

I have created a new PR that corrects for this so I will close this one out.

@tcgilbert tcgilbert closed this Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-integration Added a new source or destination
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants