Surveys
The Surveys node is an out-of-the-box integration and uses Survey API endpoints for integration. This integration helps you understand your customer's needs and improve your products or services to meet expectations. By integrating Surveys with Webex Connect, the platform capabilities can be utilized in various use cases related to customer survey management. By using the Surveys pre-built node, you can generate questionnaire URLs that can be sent through different channels.
Note
Version 1.0 of the Surveys node will be deprecated and you should not configure any new flows with this version.
It is recommended to use v1.2. In v1.2, you can pass the Timestamp as an Integer value. It will help you avoid Evaluate node to generate a future timestamp. Name, Valid After, Valid For, and Preferred Language are only available in v1.2
Questionnaires configured in the Surveys platform after release of the v1.2 Surveys node (Aug 2023), are only accessible through v1.2.
Accessing the Product
To access Webex Connect, use the directions below:
- Enter your tenant URL in the browser address bar (e.g., https://..webexconnect.io.).
- Type your username and password to log in.
- After you successfully log in, the dashboard appears with the Services tab in view.
Prerequisites
You can access the Surveys pre-built node only if it is enabled for your tenant. Reach out to your account manager for more information.
Methods and Outcomes
Here’s a brief description of the methods, and corresponding output variables and node outcomes associated with the method.
Authorization
Refer to section Node Authorizations for more information.
Note
For the Surveys node, you will have to add the authorization again by following the steps provided in the Node Authorization. If a user is using the latest version of the Surveys node, it is mandatory for a user to re-authorize the pre-built integration.
Method Name - Create a New Survey Token for a Questionnaire
Click here for more information on questionnaire.
How to Fetch All Questionnaires
To fetch questionnaires:
- Select the Method Name.
- Select the required Node Runtime Authorization from the list.
- Click Fetch All Questionnaires to fetch the questionnaires.
All the fetched questionnaires are pre-populated. - Select the required questionnaire from Available Questionnaires.
- Click Save.
Note
Interaction ID and Tracking ID are some of the recommended (not mandatory and are only used for debugging purposes) pre-fills for completing the configuration for the Surveys node and generating a survey URL. These two parameters should be unique to each survey URL. You can use flow trans ID variable or generate your own ID using Evaluate node. This is only valid for v1.1.
In v1.2 the Interaction ID (Task ID) is auto configured as one of the pre-fill at the node level and the Pre-Fills section is removed from the node UI. The pre-fill is automatically configured in the backend with Interaction ID (Task ID).
| Input Variables | Output Variables | Node Outcomes | Versions |
|---|---|---|---|
| Name: Enter a valid name for the survey to be used. Valid After: Enter the Date and Time in UTC format after which the SurveyToken will be active. Eg: MM-DD-YYYY HH:MM:SS For Eg: If you enter a date as 27th July and the URL is sent to the customer on 26th July, the URL will not be available and is shown as “Invalid URL”. Valid Till - Enter the date and time Enter the date in ISO format. Eg: yyyy-MM-ddTHH:mm:ssZ Valid For: Enter an Integer value for the date. For Eg: If you pass 5 in the Valid For column, the system automatically captures current date (UTC format) and will add 5 more days to the current date. Note: You can either use Valid Till or Valid For to enter the date and time. Preferred Language: Select the required language. This can be configured from the Surveys platform. | id - contains the questionnaire token orgId - contains the org id of the Surveys platform name - contains the tenant name validAfter - contains the range from when the url is valid validTill - contains the range until when the url is valid questionnaireId - contains the questionnaire id which is selected preFill - contains the prefill values if provided onlyForPreviewSurvey - Survey preview mode. The default is false. preferredLanguage - contains the set of languages for the survey skipWelcome - Whether to showcase welcome page before stating of survey. This is default to false always. restrictOnWebDomain - contains the list of web domains on which the url is restricted restrictFromIPSpace - contains the list of ip addresses on which the url is restricted validUses - No of times survey URL can be used. The default value is 1. surveyURL - contains the survey url responsePayload - contains the entire response payload | onInvalidData onError onInvalidChoice onTimeout onauthorizationfail createTokenForTheQuestionnaireOnSuccess failedToAddSurveyToken UserRoleNotAllowedAccessThisResource APIRequestLimitExceeded | v1.0, v1.1 and v1.2 Name, Valid After, Valid For, and Preferred Language are in available in v1.1 and v1.2. Note: v1.0 uses .NET API endpoint. v1.1 and v1.2 uses Java based API endpoints. |
Updated 4 days ago