-
Notifications
You must be signed in to change notification settings - Fork 380
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
Conversation
@stayseesong Any updates on this? |
## 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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 👍
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:
|
@stayseesong Updated the PR based on your suggestions. Waiting for your review 👍 |
@joe-ayoub-segment Is this one going straight to public beta or will it be in private beta first? |
Hi @BR4VE , @stayseesong , The docs just go live once they've been approved - @tcgilbert can you confirm please? |
@stayseesong Updated 👍. Waiting for you to review. |
Proposed changes
Merge timing