IdeaScale provides three core services that allow you to build your own connections between IdeaScale and other softwares:

  1. REST API
  2. Webhooks
  3. The IdeaScale Zapier App

Rest API

Our REST API is fully documented here and is a great tool for developers wanting to build custom scripts or applications on top of IdeaScale’s core functionality. This document focuses instead on providing easy-to-use use cases for the two other connection methods provided by IdeaScale; our custom webhook builder; and IdeaScale’s Zapier App. The target is that what follows is accessible to all IdeaScale users with a basic knowledge of the behavior or web applications and some familiarity of the IdeaScale platform. 

Webhooks 

Webhooks, also known as reverse API's, will allow you to push data from IdeaScale into another app using IdeaScales automation builder. The push is triggered by an event such as a email being received will trigger the app to notify you via slack.

Webhooks and Project Management Tools

Linking your IdeaScale community to a project management tool is a great way to ensure follow through on your best ideas! The most popular tools our clients connect with are Trello, GitHub, and Jira.
 
What is possible using a Webhook in IdeaScale: 

Using IdeaScale's Automation Builder you can create a rule that will trigger an idea to be pushed to your connected software. Below is a screenshot of the possibilities. For example, you can automate ideas to be pushed to a Trello board every time it reaches the stage Review. 

Currently the only data within the Idea that can be dynamically mapped (via post payload) is: Submitter Email, Submitter Name, Idea Title, Idea Description, Idea URL, and Idea Submitter Profile. 

Trello

To learn how to build a webhook that creates a Trello card for every idea you selected for implementation.
Method of Integration: Webhook triggered via IdeaScale’s automation builder
Platform Connected: Trello
Platform Developer Information:
Go to Community Settings > Workflow > Automation Builder and click “Create New Workflow”. You’ll get a screen that looks like this:

  1. Start by naming your new Workflow using the “Rule Name” field. This can be anything you like. 
  2. Under 'Condition', use the drop-downs to build a condition that is 'Idea'. Then select the activity you wish the Idea to go through to get pushed to Basecamp. See the above example, where we have configured the workflow to trigger when an idea reaches the Stage named “Pending Approval”. 
  3.  Under the 'Action' Category select 'Execute Webhook' in the 'Name' Section. 
  4. When all of the above is set, hit save. Hitting Save will cause a new set of options to appear. 
  5. Under 'Method Type' select Post
  6. In the URL section copy and past this link: https://api.trello.com/1/cards?key=THIS_IS_WHERE_YOUR KEY_GOES&token=THIS_IS_WHERE_YOUR_TOKEN_GOES&idList=THIS_IS_WHERE_YOUR_LIST_ID_GOES. You will be updating the URL with data specific to your Trello account and board. 
  7. Then go to Trello and login to the account you would like this connector to create cards on behalf of.
  8. Once you are logged in on Trello, open a new tab and go to https://trello.com/app-key
  9. Copy the Key provided by Trello, return to IdeaScale and replace the text “THIS_IS_WHERE_YOUR KEY_GOES” with the Key you just copied.
  10. Return to Trello, click on the “Token” Link, click allow, and then copy the Token you are provided with. Return to IdeaScale and replace the text “THIS_IS_WHERE_YOUR_TOKEN_GOES” with the Token just copied.
  11. Now return to Trello and go to your boards (https://trello.com/), click on the board you would like to send the new cards to, then open up a card in the list you would like the new cards to appear in. Once you are looking at the card add “.json” to the end of the url and hit enter. This will open up a screen of code containing the ldList: 

12. Copy the IdList, return to IdeaScale and replace THIS_IS_WHERE_YOUR_LIST_ID_GOES with the id you have copied. You now have your URL completely constructed.
13. For 'Authentication Type' select No Auth
14. Leave Parameters and Custom Headers blank
15. Under Content Type select JSON and paste the following code into the Post Payload:  {"name": "{ideaTitle}", "desc": "{ideaDesc}", "urlSource": "{ideaUrl}", "pos": "top"}
17. Hit Test. You should see a new card appear in your Trello account.
18. 'Enable' and save your Automation Rule. From now on any idea that completes your rule will get pushed to your board. Your delivery team can then begin assigning to-dos and ensuring your project gets completed.

Please Note: Trello connectors with additional functionality can also be configured if you have a Zapier starter plan or above. See below section on Zapier to learn more.

Jira

To learn how to build a webhook that creates a Jira issue for every idea you selected for implementation.
 
 Method of Integration: Webhook triggered via IdeaScale’s automation builder
 Platform Connected: Jira
 Platform Developer Information: Jira’s full Rest API documentation can be found at https://developer.atlassian.com/cloud/jira/platform/rest/
 
Go to Community Settings > Workflow > Automation Builder and click “Create New Workflow”. You’ll get a screen that looks like this:

  1. Start by naming your new Workflow using the “Rule Name” field. This can be anything you like. 
  2. Under 'Condition', use the drop-downs to build a condition that is 'Idea'. Then select the activity you wish the Idea to go through to get pushed to Basecamp. See the above example, where we have configured the workflow to trigger when an idea reaches the Stage named “Pending Approval”. 
  3.  Under the 'Action' Category select 'Execute Webhook' in the 'Name' Section. 
  4. When all of the above is set, hit save. Hitting Save will cause a new set of options to appear. 
  5. Under Method Type select Post
  6. Now, add the following URL to the URL section: https://ideascaleapitest.atlassian.net/rest/api/2/issue. Replace “ideascaleapitest.atlassian.net” with the url or your Jira instance.
  7. Then Select Basic Auth and your personal JIRA username and password (or whichever Jira account you wish to create the Jira issues) under Username and Password.
  8. Finally, under Post Payload enter the following code:

{
 "fields": {
 "project": {
 "key": "KEY"
 },
 "summary": "{ideaTitle}",
 "description": "{ideaDesc} {ideaUrl}",
 "issuetype": {
 "id": "10001"
 }
 }
 }
 
9. Replace KEY with the Key for the particular project you would like to create your new issues in. You can find the key by going to the project and looking at the URL. The key appears in the following spot: https://ideascaleapitest.atlassian.net/projects/KEY/board.
10. Hit Test. You should see a new card appear in your Jira account.
11.  'Enable' and save your Automation Rule. From now on any idea that completes your rule will get pushed to your Jira board. Your delivery team can then begin assigning to-dos and ensuring your project gets completed.

GitHub

To learn how to build a webhook that creates request to GitHub for every idea you selected for implementation.

Method of Integration: Webhook triggered via IdeaScale’s automation builder
Platform Connected: GitHub
Platform Developer Information:
Goto Community Settings > Workflow > Automation Builder and click “Create New Workflow”. You’ll get a screen that looks like this:


1. Start by naming your new Workflow using the “Rule Name” field. This can be anything you like.
2. Under 'Condition', use the drop-downs to build a condition that is 'Idea'. Then select the activity you wish the Idea to go through to get pushed to GitHub account. See the above example, where we have configured the workflow to trigger when an idea is submitted.
3. Under the 'Action' Category select 'Execute Webhook' in the 'Name' Section.
4. When all of the above is set, hit save. Hitting Save will cause a new set of options to appear.
5. Under Method Type select Post.
6. Now, add the GitHub account URL to the URL section.
7. Then Select Basic Auth and your GitHub username and password under Username and Password.
8. You can also set parameter and custom header name, value.
9. Finally, under Post Payload you can enter the following code:
{
  "name": "{emailAddress}",
  "title": "{ideaTitle}",
  "desc": "{ideaDesc}",
  "urlSource": "{ideaUrl}",
  "pos": "top"
}

10. Hit Test Webhook. You should see a new request appear in your GitHub account.
11.  'Enable' and save your Automation Rule. From now on, any submitted idea that completes your rule will get pushed to your GitHub.

5 Great Uses for IdeaScale’s Zapier App

IdeaScale has partnered with Zaiper to allow our clients to build multi-vendor workflows using a simple integration builder. Below are our most popular uses for Zapier! 

 1. Collect Submissions using Typeform, Twitter or Twilio SMS
 2. Automate onboarding emails.
 3. Set-up notifications for negative ideas
 4. Publicize Badge Wins
 5. Publicize ideas as they get traction.
 6. Send Selected Ideas to Project Management

**If you have additional questions about Zapier, please reach out to your Account Manager. 

Did this answer your question?