Skip to content

Canny Actions Destination #4965

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

Merged
merged 7 commits into from
Jul 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
186 changes: 185 additions & 1 deletion src/_data/catalog/destinations_private.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination data last updated 2023-06-29
# destination data last updated 2023-06-30
items:
- id: 54521fd725e721e32a72eec6
display_name: Intercom
Expand Down Expand Up @@ -3337,3 +3337,187 @@ items:
source_ip:
'@path': $.context.ip
trigger: type = "track"
- id: 6489bbade6fe3eb57c13bd6a
display_name: Canny (Actions)
name: Canny (Actions)
slug: canny-actions
previous_names:
- Canny (Actions)
url: connections/destinations/catalog/canny-actions
website: https://www.canny.io
status: PRIVATE_BETA
logo:
url: https://cdn.filepicker.io/api/file/mOIB6y5sTnC1sHxEWm2b
mark:
url: https://cdn.filepicker.io/api/file/wHfsugxTniu7L0ViuYat
methods:
track: true
identify: true
group: true
alias: true
screen: false
page: true
platforms:
browser: true
mobile: false
server: true
warehouse: false
components: []
browserUnbundlingSupported: false
browserUnbundlingPublic: false
replay: false
settings:
- name: apiKey
type: string
defaultValue: ''
description: >-
You can find your API Key in the Segment Integration page in your
admin settings.
required: true
label: API Key
actions:
- id: fNrQxaj4QvHUQgM3rDzk1T
name: Group
slug: group
description: >-
Updates or adds properties to a company. Company is created if it does
not exist.
platform: CLOUD
hidden: false
defaultTrigger: type = "group"
fields:
- id: 6Hc59zSPDfiKjTLSXtgA45
sortOrder: 0
fieldKey: groupId
label: Group ID
type: STRING
description: The unique identifier of the group.
placeholder: ''
defaultValue:
'@path': $.groupId
required: true
multiple: false
choices: null
dynamic: false
allowNull: false
- id: dzuh5PpJELcXNmWsKKVHDy
sortOrder: 1
fieldKey: traits
label: Group Properties
type: OBJECT
description: Properties to set on the group profile
placeholder: ''
defaultValue:
'@path': $.traits
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- id: sYBE4iNi8Gz3AWLhotWJhW
sortOrder: 2
fieldKey: type
label: Type
type: STRING
description: The type of the event
placeholder: ''
defaultValue:
'@path': $.type
required: true
multiple: false
choices: null
dynamic: false
allowNull: false
- id: sZSrj8F9KnF5TsnXi2m8jF
name: Identify
slug: identify
description: Create or update a user profile in Canny.
platform: CLOUD
hidden: false
defaultTrigger: null
fields:
- id: idCZE7QD8PqrPQkz1iSXXi
sortOrder: 0
fieldKey: userId
label: User ID
type: STRING
description: A distinct ID of an identified (logged in) user.
placeholder: ''
defaultValue:
'@path': $.userId
required: true
multiple: false
choices: null
dynamic: false
allowNull: false
- id: 8Urey1K1vjYFoRxAaepeih
sortOrder: 1
fieldKey: traits
label: User Properties
type: OBJECT
description: Properties to set on the user profile
placeholder: ''
defaultValue:
avatar:
'@path': $.traits.avatar
company:
'@path': $.traits.company
createdAt:
'@path': $.traits.createdAt
id:
'@path': $.traits.id
name:
'@path': $.traits.name
email:
'@path': $.traits.email
required: false
multiple: false
choices: null
dynamic: false
allowNull: false
- id: is43ParH6B9rj6s8QyZi8R
sortOrder: 2
fieldKey: type
label: Type
type: STRING
description: The type of the event
placeholder: ''
defaultValue:
'@path': $.type
required: true
multiple: false
choices: null
dynamic: false
allowNull: false
presets:
- actionId: fNrQxaj4QvHUQgM3rDzk1T
name: Create or update a Company
fields:
groupId:
'@path': $.groupId
traits:
'@path': $.traits
type:
'@path': $.type
trigger: type = "group"
- actionId: sZSrj8F9KnF5TsnXi2m8jF
name: Create or update a User
fields:
userId:
'@path': $.userId
traits:
avatar:
'@path': $.traits.avatar
company:
'@path': $.traits.company
createdAt:
'@path': $.traits.createdAt
id:
'@path': $.traits.id
name:
'@path': $.traits.name
email:
'@path': $.traits.email
type:
'@path': $.type
trigger: type = "identify"
37 changes: 35 additions & 2 deletions src/connections/destinations/catalog/canny-functions/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,38 @@
---
title: 'Canny-Functions Destination'
hidden: true
title: Canny (Actions) Destination
id: 6489bbade6fe3eb57c13bd6a
beta: true
hidden: true
private: true
---

{% include content/plan-grid.md name="actions" %}

[Canny](https://canny.io?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="\_blank"} is a single place for all customer feedback. It saves you time managing all the feedback while keeping your customers in the loop. Let your customers post and vote on feedback from within your website or mobile app. You'll get an organized list of feedback that you can use to inform your roadmap.

Canny maintains this destination. For any issues with the destination, [contact the Canny Support team](mailto:segment-help@canny.io).

> success ""
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Canny Segment destination. There's also a page about the [non-Actions Canny destination](/docs/connections/destinations/catalog/canny/). Both of these destinations receive data from Segment.

{% include content/ajs-upgrade.md %}

## Benefits of Canny (Actions) vs Canny Classic

Canny (Actions) provides the following benefit over the classic Canny destination:
- **Group Events**. Canny (Actions) supports group events and updates or adds properties to companies.

## Getting started

1. Go to your [Canny Admin Segment Settings](https://canny.io/redirect?to=%2Fadmin%2Fsettings%2Fsegment){:target="\_blank"}.
2. Install the integration to get your API key.
3. From the Segment web app, navigate to **Connections > Catalog**, then select the **Destinations** tab in the catalog.
4. Search for **Canny (Actions)** and select it.
5. Click **Configure Canny (Actions)**.
6. Select an existing Source to connect to Canny (Actions).
7. Enter your configuration settings.
8. Enter the Canny API key in the Canny (Actions) destination settings.
9. Enable the destination and save changes.

{% include components/actions-fields.html %}