Skip to content

Add docs for Canny (Actions) Destination #4948

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

Closed
wants to merge 3 commits into from
Closed

Add docs for Canny (Actions) Destination #4948

wants to merge 3 commits into from

Conversation

BR4VE
Copy link
Contributor

@BR4VE BR4VE commented Jun 27, 2023

Proposed changes

  • Added documentation for Canny (Actions) Destination as it is required to get the destination in public beta.

Merge timing

  • ASAP once approved, we'd like to make our destination public.

@BR4VE BR4VE requested a review from a team as a code owner June 27, 2023 07:47
@BR4VE BR4VE requested review from stayseesong and removed request for a team June 27, 2023 07:47
@BR4VE
Copy link
Contributor Author

BR4VE commented Jun 28, 2023

@stayseesong Any updates on this?

Comment on lines 26 to 53
## Identify

If you haven't had a chance to review spec, take a look to understand what the Identify method does. An example call would look like:

```js
analytics.identify("userId123", {
email: "john.doe@example.com",
name: "John Doe",
});
```

Identify calls will be sent to Canny as an identify event. Once identified, users will appear in Canny and will appear in your vote-on-behalf feature. The `name` and `email` traits are **required** fields.

## Group

An example call would look like:

```js
analytics.group("0e8c78ea9d97a7b8185e8632", {
name: "X Corp",
});
```

Group calls will be sent to Canny as an group event. Once sent, groups will appear in Canny as companies attached to users. The `name` trait is a **required** field.

### Custom Fields

Custom Fields is a list of [traits](/docs/connections/spec/identify/#traits) to be imported as custom fields for Identify events.
Copy link
Contributor

Choose a reason for hiding this comment

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

@BR4VE are you sure you want to include these sections? These sections aren't needed for actions destinations and are usually only needed for the classic docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@stayseesong Thanks for mentioning this. I was not sure it it's required or not. Now I removed it 👍

@stayseesong
Copy link
Contributor

Also, not sure if you wanted to add this, but normally our Actions docs has a benefits section. Here's the template:

Benefits of <destination_name> (Actions) vs <destination_name> Classic

<destination_name> (Actions) provides the following benefits over the classic <destination_name> destination:

  • Main point 1. One or two sentences that back up the main point.
  • Main point 2. One or two sentences that back up the main point.

@BR4VE BR4VE requested a review from stayseesong June 29, 2023 07:27
@BR4VE
Copy link
Contributor Author

BR4VE commented Jun 29, 2023

@stayseesong Updated the PR based on your suggestions. Waiting for your review 👍

@stayseesong
Copy link
Contributor

@joe-ayoub-segment Is this one going straight to public beta or will it be in private beta first?

@joe-ayoub-segment
Copy link
Contributor

Hi @BR4VE , @stayseesong ,

The docs just go live once they've been approved - @tcgilbert can you confirm please?

@BR4VE
Copy link
Contributor Author

BR4VE commented Jun 30, 2023

@stayseesong Updated 👍. Waiting for you to review.

@BR4VE BR4VE requested a review from stayseesong June 30, 2023 07:58
@stayseesong
Copy link
Contributor

Looks good @BR4VE, I'm going to close this PR out as I created an editable version for the docs team to work on here #4965

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants