Integrating with Third-party applications using SurveySparrow API

SurveySparrow API lets you integrate your applications such as CRM, Help desk, and HRM Software. With tight integration, you can achieve more solutions like triggering a survey when the ticket is closed in a help desk, or adding a new employee to SurveySparrow as you enter the information in the HRM system. 

Let's see how you can send a survey data when a ticket is closed in your help desk system:

1. Create a new app under Settings.

2. Once the survey page opens, choose Apps & Integrations.

3. Click on the "Create a Custom app" button at the top.

4. Enter the name and define the scope. Hit Save once done.

5. The moment you click on Save, the following screen appears. Copy the generated Access Token.

6. Now, go to your help desk system and set up a webhook to call SurveySparrow API endpoint https://api.surveysparrow.com/v3/channels.

7. Set your authorization header  as 'Authorization: Bearer <access-token>'.

8. You can obtain{share_id} either from the URI of the email share or through our list shares API.

In our case, the share id is 176529. 

9. Set your data as the email you want the survey to be sent (ticket requester email id).

Note: If some webhook executions fail with 422, check whether the payload contains an empty email field (for example, when a help desk user does not have an email address).

10. If you are using an on premise system or any programming, you can also call the API through supported programming languages as well.

 A sample request will look like the following:

    curl --request PUT 
  --url 'https://api.surveysparrow.com/v3/channels' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "contacts": [
    "[email protected]"
  ]
}

Note: You can also refer to our API Documentation to explore other API endpoints.