| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your own connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). More. |
The Survicate modulesThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) More allow you to watch, and list surveys in your Survicate account.
Prerequisites
-
A Survicate account
In order to use Survicate with Boost.spaceCentralization and synchronization platform, where you can organize and manage your data. More IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. More, it is necessary to have a Survicate account. If you do not have one, you can create a Survicate account at panel.survicate.com/#/signup.
![[Note]](https://docs.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/note.png) |
Note |
|---|---|
|
The moduleThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) More dialog fields that are displayed in bold (in the Boost.space Integrator scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive. More, not in this documentation article) are mandatory! |
To connect your Survicate account to Boost.space Integrator you need to obtain the API Key from your Survicate account and insert it in the Create a connection dialog in the Boost.space Integrator module.
1. Log in to your Survicate account.
2. Click Settings (
) > Integrations > Data Export API.
3. Copy the API Key to your clipboard.
4. Go to Boost.space Integrator and open the Survicate module’s Create a connection dialog.
5. In the Connection name field, enter a name for the connection.
6. In the API Key field, enter the API key copied in step 3 and click Continue.
The connection has been established.
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... when a userCan use the system on a limited basis based on the rights assigned by the admin. More answers a question.
|
WebhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. Name |
Enter a name for the webhook. |
|
Connection |
See Connecting to Survicate Webhook using Boost.space Integrator to add the webhook in your Survicate account.
Triggers when a respondent completes the survey.
|
Webhook Name |
Enter a name for the webhook. |
|
Connection |
See Connecting to Survicate Webhook using Boost.space Integrator to add the webhook in your Survicate account.
Returns single survey data by the indicator.
|
Connection |
|
|
Survey ID |
Select the Survey ID whose details you want to retrieve. |
Performs an arbitrary authorized API call.
|
Connection |
||||
|
URL |
Enter a path relative to
|
|||
|
Method |
Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
|||
|
Headers |
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
|||
|
Query String |
Enter the request query string. |
|||
|
Body |
Enter the body content for your API call. |
The following API call returns all the surveys from your Survicate account:
URL: /v1/surveys
Method: GET
Matches of the search can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. More > Body. In our example, 7 surveys were returned:
Returns a list of all surveys.
|
Connection |
|
|
Limit |
Set the maximum number of surveys Boost.space Integrator should return during one scenario execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Returns an arrayWithin a bundle, data items of the same type are sometimes in an array. You can find an array by looking at the details of a bundle. Depending on the details of your scenario, you can map other modules to a specific item in an array or use iterators and aggregators to manipulate your data into other formats. When mapping,... More of questions and their answers, along with attributes of respondents.
|
Connection |
|
|
Survey ID |
Select the Survey ID whose responses you want to list. |
|
Limit |
Set the maximum number of survey responses Boost.space Integrator should return during one scenario execution cycle. |
|
Note |
|---|---|
|
You need a Survicate Upgraded account to enable and use the webhooksA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers.. |
1. Open any Watch module, enter the details as mentioned in the respective module description, and copy the address to your clipboard.
2. Click Settings > Integrations > Enable the Webhook.
3. Click the Edit Icon (
) on the survey for which you want to enable the webhook > Settings > Webhooks.
4. Enable the responses for which you want to receive the triggers by entering the URL address copied in step 1 and click Save.
You have successfully added the webhooks.