API and Webhooks

The API and Webhooks provide a means to extend the functionality of SmartSurvey and your own systems by initiating various operations from either your system or SmartSurvey. It is common to use one or both of these in order to set up a relatively advanced integrated system.

Example: You have a helpdesk system that sends out a satisfaction survey at a certain point. By calling the API, your system can initiate this action. Afterwards, perhaps you want a completed survey to set some data in your helpdesk so that either you can link to their response or mark it as completed. You could use a webhook to achieve this.

The API and Webhooks require some technical setup so depending on what exactly you are doing and with what software you are doing it with, you might require a developer or system admin to carry out these tasks for you.

API

The SmartSurvey API gives you access to secure survey data for use in your own app. It is RESTful and is organised around the main resources you’re familiar with from the SmartSurvey web interface.

To get started, head over to the SmartSurvey API Documentation.

If you would like to go directly to the API endpoint references, then click here.

If you want SmartSurvey to do something that is initiated by your system, you should use the API

Webhooks

The SmartSurvey Webhook API enables you to subscribe and unsubscribe to receive notifications about certain events when they occur in SmartSurvey.

To get started, head over to the SmartSurvey Webhooks Documentation.

If you want your system to do something that is initiated by SmartSurvey, you should use Webhooks

Was this guide helpful?