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.
Use SlapFive APIs to integrate with other apps
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:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
[ { "__typename": "Board", "name": "This is the name of the first board being returned", "id": "cjlfgkasm0h8d01409zdnj2sk" }, { "__typename": "Board", "name": "This is the name of the second board", "id": "nkol3i6pr0u2p0145hm033r8j" } ] |
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:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
{ "board": { "stories": [ { "customer": { "avatarImage": { "mimeType": "image/jpeg", "url": "https://media.slapfive.com/i7160b674-cbf0-5a71-b529-6333e3b4ddd4?generation=1536773564212306&alt=media", "id": "cjlzfd0kp0enb0181yvt72pvm", "__typename": "Media" }, "name": "Joseph Smith", "title": "VP of Marketing", "company": { "competitorsReplaced": "Competitor X", "since": "2016", "name": "ABC Industries", "industry": "Computer Software", "businessGoals": "Grow revenue with customer voice", "__typename": "Company", "id": "cjlzfbp5f0e8v0187tsk73hnx", "location": "Boston, MA", "productsOwned": "SlapFive Platform", "image": { "mimeType": "image/png", "url": "https://media.slapfive.com/id120716f-3670-41af-a1d7-8d6419299473?generation=1536773622551914&alt=media", "id": "cjlzfcz830f4n0122jtlf6kj4", "__typename": "Media" }, "size": "1,001-5,000 employees" }, "__typename": "Customer", "lname": "Smith", "fname": "Joseph", "id": "cjlzfd0ky0ena0191dyrz7255" }, "sourceUrl": "https://www.abcindustries.com/stories", "prompt": { "title": "How has your life changed by using SlapFive?", "__typename": "Prompt", "id": "cjlzfgkxl0fjy01976dl47dua" }, "nextReviewDate": "2020-07-20T00:00:00.000Z", "reviewStatus": "Released", "permission": "Public", "text": "This is the content in the Story Text field", "tags": "Tag1", "transcript": "This is the content in the Transcription Text field", "__typename": "Story", "summary": "This is the Story Summary", "source": "Customer interview", "media": { "mimeType": "video/mp4", "url": "https://media.slapfive.com/v80d88b28-cd84-4d87-b503-9ceae9dd9208?generation=1539131279057869&alt=media", "id": "cjn2f6h0f123l0165jnnlo4hi", "__typename": "Media" }, "capturedByUser": { "__typename": "User", "name": "Jeff Ernst", "id": "cjdknd457654nhc015961vvj69l" }, "type": "Video", "id": "cjn2f6h0f123k01652x64q3mx" }, Repeat for next Story. |
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:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
{ "customer": { "avatarImage": { "mimeType": "image/jpeg", "url": "https://media.slapfive.com/i335722ab-a868-40ae-a625-6aa73000e09c?generation=1536711865414457&alt=media", "id": "cjlyelbbf2aku0164pfankbyg", "__typename": "Media" }, "name": "Joseph Smith", "title": "VP of Marketing", "company": { "competitorsReplaced": "Competitor X", "since": "2016", "name": "ABC Industries", "industry": "Computer Software", "businessGoals": "Increase impact of customer voice on revenue", "__typename": "Company", "id": "cjlyekqko29g90148kg9c87u3", "location": "Boston, MA", "productsOwned": "SlapFive Platform", "image": { "mimeType": "image/svg+xml", "url": "https://media.slapfive.com/ie7b72b9a-4c71-4257-bf7f-98743806e812?generation=1543889321542562&alt=media", "id": "cjp93ubjr0bsi0151z125n07o", "__typename": "Media" }, "size": "500-1000 employees" }, "__typename": "Customer", "lname": "Smith", "fname": "Joseph", "id": "cjlyelbbf4akt0163slwbrayz" }, "sourceUrl": "https://www.abcindustries.com/stories", "prompt": { "title": "What do you find compelling about this new approach to customer voice", "__typename": "Prompt", "id": "cjlyg2kou055b01637zogkz2g" }, "permission": "Public", "text": "This is the content in the Story Text field", "transcript": "This is the content in the Transcription Text field", "__typename": "Story", "source": "Customer Interview", "media": { "mimeType": "audio/mp3", "url": "https://media.slapfive.com/a330bf98f-3b33-4517-8ce6-74ce5da0e24e?generation=1536773743406387&alt=media", "id": "cjlzfet110fvf01403dcf02ye", "__typename": "Media" }, "type": "Audio", "id": "cjlzfet010fae01407t7vqc5c" } Repeat for next Story. |
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:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
{ "story": { "customer": { "avatarImage": { "mimeType": "image/jpeg", "url": "https://media.slapfive.com/ie2387756-274d-4bb1-af28-0b8b1c26bd50?generation=1536886937722051&alt=media", "id": "cjm1atj3m089j0123u8qnruqt", "__typename": "Media" }, "name": "Joseph Smith", "title": "VP of Marketing", "company": { "competitorsReplaced": "Competitor X", "since": "2015", "name": "ABC Industries", "industry": "Computer Software", "businessGoals": "Recorded references,better case studies", "__typename": "Company", "id": "cjm1at33e054d036892n2teyt", "location": "Boston, MA", "productsOwned": "Product A", "image": { "mimeType": "image/png", "url": "https://media.slapfive.com/ie82d34c0-50gg-4473-a04a-6003fafb0c4a?generation=1536886962789086&alt=media", "id": "cjm1athgr05ac0162z7nk8hyf", "__typename": "Media" }, "size": "500-1000 employees" }, "__typename": "Customer", "lname": "Joseph", "fname": "Smith", "id": "cjm1atj3m058i0148j7v3362z" }, "sourceUrl": "https://www.abcindustries.com/stories", "prompt": { "title": "Why did you decide to replace your old ERP system?", "__typename": "Prompt", "id": "cjp1siu2d0prc0197qpz7wzql" }, "nextReviewDate": null, "reviewStatus": "Released", "permission": "Public", "text": "This is the content in the Story Text field", "tags": "Banking,Data Center", "transcript": "This is the content in the Transcription Text field", "__typename": "Story", "summary": "This is the content in the Story Summary field", "source": "Mobile Prompt", "media": { "mimeType": "video/mp4", "url": "https://media.slapfive.com/v80d88b54-cd67-4d87-b503-9ceae8dd9208?generation=1539131279057869&alt=media", "id": "cjxgl0lti03080180v5orv30j", "__typename": "Media" }, "capturedByUser": { "__typename": "User", "name": "Jeff Ernst", "id": "cjdknd7e6ynhc017891vvj69l" }, "type": "Video", "id": "cjxgl0lth030801803zqxh1mn" } } |
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:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
{ "email":"jsmith@abcindustries.com", "fname":"Joseph", "lname":"Smith", "companyName":"ABC Industries", "phone":"616.765.6787", "title":"VP of Marketing", "linkedInUrl":"https://www.linkedin.com/in/josephsmith/", "twitterHandle":"@joejoesmitty", "companySize":"100-500 employees", "companyIndustry":"Computer Software", "companyLocation":"Boston, MA", "companySince":"July 2016", } |
Sample JSON output:
|
1 2 3 4 5 |
{ "customer": { "id": "cjy4vfgam01eo0197xg4uihd3" } } |
