Overview

SurveySensum APIs allow you to integrate SurveySensum with your existing application ecosystem, including CRM, HRM, and Helpdesk applications.

By using Open APIs, you can create your own workflows without depending on the SurveySensum user interface. For example, you can use APIs to share surveys when a particular event occurs or add contacts to SurveySensum.

Let's see how you can create a SurveySensum application to access and use these APIs.

Creating a SurveySensum Application

Follow these steps to create your application:

Step 1: Navigate to Settings → Integrations and Apps and create a new application.

Step 2: Enter an application name and a short description. Both fields are mandatory.

Step 3: By default, all permissions are granted for using the API.

Step 4: An access token is also generated automatically with the default permissions.

Step 5: You can modify the permissions according to your requirements. Once you change the permissions, you need to regenerate the access token.

Using the Access Token with APIs

Once your application is created, you can use the generated access token to perform various tasks through the SurveySensum APIs.

For example, if you want to retrieve the list of contacts in your SurveySensum account, you can make an HTTP GET request using your preferred programming language. The response will contain the contact details in JSON format.

1. Retrieve the List of Contacts

Use the following API request:

curl --location --request GET \
'https://open-api.surveysensum.com/api/v1/Contacts' \
--header 'Authorization: Bearer <token>'

2. Set Up a Webhook

If you want an event in SurveySensum to trigger an action in your CRM, you can set up a webhook.

For example, when a new survey response is received in SurveySensum, a webhook can trigger an action inside your CRM.

To configure this, make an HTTP POST request to the following endpoint:

curl --location --request POST \
'https://open-api.surveysensum.com/api/v1/Webhooks' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
    "hookurl": "https://your.webhook/3eefd234-266c-8e8e-b2c8-fb7d608d24f6",
    "surveyGuid": "9a6f14e2-bdbe-4c1a-aa0f-7b60070c9128",
    "variableIds": ["vz1","vz2","vz3"]
}'

The variable IDs and text mapping for the questions can be retrieved by making an HTTP GET request to the QuestionnaireMap API endpoint.

Explore More API Endpoints

You can refer to our API Documentation to explore other available API endpoints.