Use SlapFive APIs to integrate with other apps

You’ve captured all this great customer voice content in SlapFive, now you want to integrate with other applications to pass content into SlapFive, pull SlapFive content out, or trigger workflows. We’ve got you covered. SlapFive has a set of simple but powerful APIs that enable this integration with just about any app you can think of. This article gives you some ideas for the types of integration use cases that are possible, and explains how to use the APIs.

Ideas for what you can do with these APIs

  • Your website developers can access SlapFive customer voice content and have total control over how it is presented on your site.
  • You can export your Stories and Boards to a spreadsheet.
  • You can create front-end forms that your customers can use to join your Customer Voice program and have that form data create new Customer records in SlapFive.
  • You can synchronize customer records between SlapFive and your marketing automation platform or CRM.
  • You can work with SaaS integration platforms like Zapier to build triggers and actions.

How to use the APIs

Authentication

When making requests to any SlapFive API, you must include “api-authorization” as a key in the HTTP header, with your API Key as the value. To find or generate your API Key, go to your Admin menu and click the “(Your Company Name) Client Settings” menu, and scroll down to the API Keys section, where you can copy and paste the value that appears, or generate a new one.

Available APIs

Get All Boards
Get a Specific Board and All its Stories
Get All Stories
Get a Specific Story
Create or Update a Customer

 

Get All Boards

This API returns all Boards in an array, with the Board Name and Board ID.

Method: GET
URL: https://your_company.slapfive.com/api/api/boards/
Sample JSON output:

 

Get a Specific Board and All its Stories

This API accepts a Board ID as parameter and returns that Board along with all the Stories on that Board. The Stories are returned with all the data about the Customer who contributed the Story.

Method: GET
URL: https://your_company.slapfive.com/api/api/boards/<boardID>
Sample JSON output:

 

Get All Stories

This API returns all Stories, in an array, with all the information from the Story and the Customer who contributed the Story.

Method: GET
URL: https://your_company.slapfive.com/api/api/stories/
Sample JSON output:

 

Get a Specific Story

This API accepts a Story ID as parameter and returns that Story with all the data about the Customer who contributed the Story.

Method: GET
URL: https://your_company.slapfive.com/api/api/stories/<storyID>
Sample JSON output:

 

Create or Update a Customer

This API accepts JSON with information about a customer. If a Customer record doesn’t exist for the email address provided, it creates a new Customer. If a Customer does already exist, it updates the Customer record. In either case it returns the Customer ID.

Method: POST
URL: https://your_company.slapfive.com/api/api/customers
Required for updating a Customer: email
Required for creating new Customer: email, fname, lname, companyName
Optional: phone, title, linkedInUrl, twitterHandle, companyIndustry, companyLocation, companySize, companySince

Sample JSON request data:

Sample JSON output: