Comment on page
SlapFive API
SlapFive has a powerful Application Programming Interface (API) that includes webhooks, GET and POST endpoints.
When making requests to any SlapFive API endpoint, 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 Client Settings, and scroll down to the API Keys section, where you can copy and paste the value that appears, or generate a new one.
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/
This returns Boards that have been created or changed within the specified number of hours.
Method: GET
URL: https://your_company.slapfive.com/api/api/boards/?hoursBack=XX
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>
Subscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/subscribe
body: {
‘webhook_url’: the URL that the webhook calls when a Board is created/updated
‘webhook_id’: ‘board’
}
Unsubscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe
body: {
‘webhook_url’: the URL that was subscribed
}
If a Board record exists for the id provided, it updates that record, otherwise it creates a new record. In either case it returns the id.
Method: POST
URL: https://your_company.slapfive.com/api/api/boards/
Required: name
Sample JSON request data:
{
“id”:”cjy4vfgam01eq8357xg4uihd3”,
“name”:”Customer Success Story for IGM”,
“template_id”:”cjy4vfgam01eo0197xg4uihd3”,
“headline”:”IGM transforms its customer experience with help from Sandbox”,
“tagline”:″Success Story",
“body”:”This is a sentence or two of text.”,
“customUrl”:”https://sandbox.slapfive.com/b/435gdfw34/IGM”,
“ctaHead”:”See Sandbox in Action”,
“ctaCopy”:”This is a sentence or two of text.”,
“ctaLink”:”https://sandbox.com/demo”,
“ctaLinkText”:”Sign up for a demo”,
"tags":"Large, Medium",
“activityTypeOnView_id”:”cjy4vfgam01eq8357xg4uihd3”,
“howToUse”:”This is a sentence or two of text.”,
“useAtStages”:”Qualification”,
“tokenAccessOnly”:”true”,
“tokenAccessForcedExpirationDays”:”2”,
“usePreMessage”:”true”,
“preMessageText”:”This is a sentence or two of text.″,
“preMessageButtonText”:”Agree”,
“usePreMessageReceipt”:”true”,
"customFieldData" [
"showInSalesforce":"Yes",
"showInHighSpot":"No"
]
}
Sample JSON output:
{
“board”: {
“id”: “cjy4vfgam01eo0197xg4uihd3”
}
}
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/
This API returns Stories that have been created or changed within the specified number of hours.
Method: GET
URL: https://your_company.slapfive.com/api/api/stories/?hoursBack=XX
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>
Subscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/subscribe
body: {
‘webhook_url’: the URL that the webhook calls when a Story is created/updated
‘webhook_id’: ‘story’
}
Unsubscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe
body: {
‘webhook_url’: the URL that was subscribed
}
If a Story record exists for the id provided, it updates that record, otherwise it creates a new record. In either case it returns the id.
Method: POST
URL: https://your_company.slapfive.com/api/api/boards/
Required: name
Sample JSON request data:
{
“id”:”cjy4vfgam01eq8357xg4uihd3”,
“customerId”:”cjy4vfgam01eo0197xg4uihd3”,
“customerEmail”:”[email protected]”,
“promptId”:”cjy4vfgam01eo0197xg4uihd3”,
“type”:″Video",
“url”:”https://sandbox.com/asdfsadf”,
“label”:”What is your favorite thing about Sandbox?”,
“text”:”See Sandbox in Action”,
“summary”:”This is sentences of text.”,
“transcript”:”This is sentences of text.”,
“permission”:””,
"reviewStatus":"Released",
“source”:”Customer inteview”,
“sourceUrl”:””,
“tags”:”Qualification”,
“language”:”true”,
“capturedByUserId”:”cjy4vfgam01eo0197xg4uihd3”,
“capturedByUserEmail”:”[email protected]”,
“nextReviewDate”:”2024-06-12 12:00:00″,
"dynamicFields.color":"Red"
}
Method: GET
URL: https://your_company.slapfive.com/api/api/customers/
Method: GET
URL: https://your_company.slapfive.com/api/api/customers/?hoursBack=XX
Method: GET
URL: https://your_company.slapfive.com/api/api/customers/<memberID>
Subscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/subscribe
body: {
‘webhook_url’: the URL that the webhook calls when a Member is created/updated
‘webhook_id’: ‘member’
}
Unsubscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe
body: {
‘webhook_url’: the URL that was subscribed
}
If a Member record exists with the Email or Salesforce Contact ID provided, it updates that record, otherwise it creates a new record. In either case it returns the Customer ID.
Method: POST
URL: https://your_company.slapfive.com/api/api/customers/
Required for updating a Member: email
Required for creating new Member: email, fname, lname, companyName
Sample JSON request data:
{
“email”:”[email protected]”,
“fname”:”Joseph”,
“lname”:”Smith”,
“companyName”:”ABC Industries”,
“phone”:”616.765.6787″,
“title”:”VP of Marketing”,
“activityTypesWillingToDo”:”Speak with an industry analyst, Take a Reference call, Network with peers”,
“linkedInUrl”:”https://www.linkedin.com/in/josephsmith/”,
“twitterHandle”:”@joejoesmitty”,
“salesforceContactId”:”4GH876JhG9765763″,
“type”:”Client”,
“activeStatus”:”Active”,
“inviteStatus”:”Member”,
“engagementNote”:”Joe is unavailable until March 15 because of a product launch.”,
"dynamicFields.tshirtsize":"Large",
“companyActiveStatus”:”Active”,
“companyProgramStatus”:”Member”,
“companyDescription”:”Global Manufacturing company”,
“companySize”:”100-500 employees”,
“companyIndustry”:”Computer Software”,
“companyLocation”:”Boston, MA”,
“companySince”:”July 2016″,
“companyProductsOwned”:”Product A, Product B, Product C”,
“companyCompetitorsReplaced”:”Competitor X”,
“companyBusinessGoals”:”World Domination and hyper-growth”,
“companySalesforceAccountId”:”4GH876JhG9765763″,
“companyMatchingField1″:”Tier 2”,
“companyMatchingField2″:”Manufacturing”,
“companyMatchingField3″:”Any value”,
"companyDynamicFields.productFamily":"Product Line X"
}
Sample JSON output:
{
“customer”: {
“id”: “cjy4vfgam01eo0197xg4uihd3”
}
}
Method: GET
URL: https://your_company.slapfive.com/api/api/companies/
By default, this endpoint gets Companies changed in the last 24 hours. To also get Companies changed more than 24 hours ago, append the URL with /?hoursBack=XX as described in Get Companies That Have Been Created or Changed in the Last XX Hours.
Method: GET
URL: https://your_company.slapfive.com/api/api/companies/<companyID>
Method: GET
URL: https://your_company.slapfive.com/api/api/companies/?hoursBack=XX
Subscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/subscribe
body: {
‘webhook_url’: the URL that the webhook calls when a Company is created/updated
‘webhook_id’: ‘company’
}
Unsubscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe
body: {
‘webhook_url’: the URL that was subscribed
}
If a Company record exists with the Company Name or Salesforce Account ID provided, it updates that record, otherwise it creates a new record. In either case it returns the Company ID.
Method: POST
URL: https://your_company.slapfive.com/api/api/companies/
Required for updating a Company: name
Required for creating new Member: name
Sample JSON request data:
{
“name”: “ABC Company”,
“description”: “Large Manufacturing Company”,
“size”: “100 employees”,
“industry”: “Manufacturing”,
“location”: “Houston, TX”,
“since”: “1995”,
“productsOwned”: “Product A”,
“competitorsReplaced”: “Competitor A”,
“businessGoals”: “Make more money”,
“salesforceAccountId”: “456hg45kj64j25332”,
“matchingField1”: “Texas”,
“matchingField2”: “”,
“matchingField3”: “”,
“engagementNotes”: “”,
“activeStatus”: “Active”,
“programStatus”:”Member”,
“anonymizedName”: “”,
“permissions”: [
“Referenceable”,
“Name Drop”
]
"dynamicFields.productFamily":"Product Line X"
}
Sample JSON output:
{
“company”: {
“id”: “cjy4vfgam01eo0197xg4uihd3”
}
}
Method: GET
URL: https://your_company.slapfive.com/api/api/activityLogs/
Method: GET
URL: https://your_company.slapfive.com/api/api/activityLogs/?hoursBack=XX
Subscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/subscribe
body: {
‘webhook_url’: the URL that the webhook calls when an Activity is created/updated
‘webhook_id’: ‘activityLog’
}
Unsubscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe
body: {
‘webhook_url’: the URL that was subscribed
}
If an Activity History record exists for the id provided, it updates that record, otherwise it creates a new record. In either case it returns the id.
Method: POST
URL: https://your_company.slapfive.com/api/api/activity/
Required for creating new Activity: email, activityName, date
Optional: notes
Sample JSON request data:
{
“email”:”[email protected]”,
“activityName”:”Speak at a conference”,
“date”:”2024-06-12 12:00:00″,
“notes”:”Spoke on customer panel at ABC Customer Conference”,
}
Sample JSON output:
{
“status”: “ok”,
“message”: “added activity type ‘Speak at a conference’ to John Smith”
}
Method: GET
URL: https://your_company.slapfive.com/api/api/requests/
Method: GET
URL: https://your_company.slapfive.com/api/api/requests/?fulfillmentHoursBack=XX
Subscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/subscribe
body: {
‘webhook_url’: the URL that the webhook calls when a Request is created/updated
‘webhook_id’: ‘request’
}
Unsubscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe
body: {
‘webhook_url’: the URL that was subscribed
}
If a Request record exists for the id provided, it updates that record, otherwise it creates a new record. In either case it returns the id.
Method: POST
URL: https://your_company.slapfive.com/api/api/requests/
Required: needDescription, needByDate
Sample JSON request data:
{
“id”: “53k3kj6322k45k3224”,
“needDescription”: “2 manufacturing customers in EMEA using product X”,
“needFor”: “Big Company sales opportunity”,
“activityType”: “Take a reference call”,
“needByDate”: “2024-04-29”,
“requestDate”: “2024-04-20”,
“dynamicFields.useCase”: “Supply Chain Optimization”,
“requesterEmail”: “[email protected]”,
“requesterName”: “Bill Salesguy”,
“team ”: “Sales”,
“requestStatus”: “Texas”,
“fulfillmentDate”: “”,
“assignedTo”: “[email protected]”,
“note”: “This is the note field.”,
“opportunityId”: “456hg45kj64j25332”,
“preferredCustomers”:”IBM, Cisco”
}
Sample JSON output:
{
“request”: {
“id”: “cjy4vfggds534397xg4uihd3”
}
}
Subscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/subscribe
body: {
‘webhook_url’: the URL that the webhook calls when a Request Fulfillment Member is created/updated
‘webhook_id’: ‘fulfillmentMember’
}
Unsubscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe
body: {
‘webhook_url’: the URL that was subscribed
}
Subscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/subscribe
body: {
‘webhook_url’: the URL that the webhook calls when a Request is created/updated
‘webhook_id’: ‘share’
}
Unsubscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe
body: {
‘webhook_url’: the URL that was subscribed
}
Subscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/subscribe
body: {
‘webhook_url’: the URL that the webhook calls when a Request is created/updated
‘webhook_id’: ‘pageView’
}
Unsubscribe:
Method: POST
URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe
body: {
‘webhook_url’: the URL that was subscribed
}
Method: POST
URL: https://your_company.slapfive.com/api/api/sendPrompt
Required parameters: customerId, promptId or promptGroupId
Optional parameters: customGreeting, customSubject