add_web_service
Add a Web Service call to a Qualtrics survey flow and map JSON response values to embedded data fields for piped text.
Instructions
Add a Web Service element anywhere in the survey flow. Response values can be mapped to embedded data fields for downstream piped text. For authentication, headers, or advanced Qualtrics fields, use additionalFields.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"surveyId": "<surveyId>",
"url": "<url>",
"responseMapping": "<responseMapping>"
},
"name": "add_web_service"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Target URL for the HTTP call (can include piped text like ${e://Field/ResponseID}) | |
| method | No | HTTP method (default: GET) | |
| surveyId | Yes | The Qualtrics survey ID | |
| placement | No | Insertion position (default: beginning) | |
| requestParams | No | Request parameters sent as the body (for POST/PUT) or query string (for GET) | |
| referenceFlowId | No | Required for before, after, inside_beginning, and inside_end | |
| responseMapping | Yes | Map response JSON paths to embedded data fields | |
| additionalFields | No | Other WebService definition fields, such as headers or authentication; merged last | |
| declareResponseFields | No | Also insert an EmbeddedData declaration for mapped fields (default: true) |