Extension SDK | XM Community
Skip to main content

Extension SDK

Discuss Extension SDK solutions, best practices, & more.

  • 25 Topics
  • 50 Replies
25 Topics
J
JaimeIgnacio
asked in Extension SDK
Functions initializeProjectWithExtRefId and evaluateProject not working in ReactNative

Hi guys, we are trying to display a survey in our mobile app with React Native.But when trying to initialize our qualtrics project with the initializeProjectWithExtRefId function indicating the BrandId and ProjectId we do not have a correct response.initializationResults:  {} Then, when calling the function evaluate Project we have the following response.targetingResults:  {"ERROR":{"passed":false,"surveyUrl":null,"creativeType":null}}We are following the following guide https://api.qualtrics.com/f23ebb864cba1-getting-started-with-react-native-sdk¿How can we validate that the intercept and the survey created are well configured? or check if it is another problemReact-Native 0.64.0 (with Typescript) iOS 14.0 Qualtrics 2.4.1Thanks.

2742
Nam Nguyen
QPN Level 8 ●●●●●●●●
14 days ago
ElianManev
ElianManev
asked in Extension SDK
XM Function

Hello Team, I am trying to build a new Extension as I have a code task that requires a bit more than 10 seconds to run, thus I’ve read in the Dev documentation that there is an option to build an XM function (Extension) which allows you to run 45 seconds server side code. My question is very simple, but I would like to double check it with someone that has the experience in building such extensions. The task of the plugin is to simply run the following code // Function to transform CSV to JSONfunction codeTask() { const payload = `~{ch://OCAC_wMUqBo0Sh8iIVIv/data}`; function transformCSVtoJSON(csvData) { const lines = csvData.split('\n'); const results = []; // Extract headers const headers = lines.split(',').map(header => header.trim().replace(/"/g, '')); console.log(headers); // Process each line starting from the second row for (let i = 1; i < lines.length; i++) { const values = lines[i].split(',').map(value =&g

422
qHubert
Qualtrics Employee
20 days ago
C
Level 1 ●
ClemensLevel 1 ●
asked in Extension SDK
HELP! Changing the relative proportion of the bar chart and Table for open answers.

Hello Together!I have very long questions (which I have to display completely) and I just need minimal part of the bar chart. A little bit like this:So I´m starting with the developer SDK, but it seems to need more time than I have, it get deep enough. Due Date is Monday. I know, it was not my idea.So I´m looking for suggestions, how get a result with a less knowledge about the SDK as possible.Perhaps somebody knows a way to adapt the original widgets?Or have somebody a bar chart plugin, which I can use to adapt?Same with a stupid table, but Qualtrics is not offering the right format.I´m looking for: It would be good, if I could combine the answers to an chained string, but it´s also ok, if in the column just stand the first answer (it will be filtered out to 1 single answer).I would be sooo thankful for some help! Thanks a lot!KRClemens 

270
C
Level 1 ●
1 month ago
JesperAndersen
QPN Level 4 ●●●●
JesperAndersenQPN Level 4 ●●●●
asked in Extension SDK
Using Data sources in Extensions

​For some tasks, I can see that you can just select the task you want the data from, instead of pushing it via fields in the extension, like this:How is this done, and is there anyway I can see what is needed to make data available for the Basic Transform task for example, or how to get data from it?How do you define or access data sources?This seems to be a much better way to do this rather than passing loads of user data as raw text in an export.​

412
chackbusch
QPN Level 5 ●●●●●
3 months ago
JesperAndersen
QPN Level 4 ●●●●
JesperAndersenQPN Level 4 ●●●●
asked in Extension SDK
Limit on /ex-projects/{projectId}/participants?

In the documentation for:https://api.qualtrics.com/9f1dc7785bd26-get-participants-postI do not see any limitation on numbers of calls, but if I run 100 calls in parallel, then the response after approx 65 of them are: 429 - Too Many Requests Is there a limit on this type of call or am I hitting another limit? I also raised a request for office hours 3 weeks ago, but have not heard anything back? 

241
qHubert
Qualtrics Employee
4 months ago
JesperAndersen
QPN Level 4 ●●●●
JesperAndersenQPN Level 4 ●●●●
asked in Extension SDK
Allow extension to run for more time?

Hi @qHubert,I’m not sure where to direct this question, so I’m starting with you :)Is there any way it would be possible to have an extension run for more than the default 45 seconds?In short, I’m building an extension that would need to process a lot of users in a project, and perform various tasks on them. In my current code, I had to build in limits to stop the code from processing too many users at once, as this would mean the code would hit the 45 second limit and then fail.This means that I can fairly safely process 250 users in 45 seconds, but if the server is slow, then I can risk that this would not even work. Running this every hour would give me the ability to process 6000 users per day, but in some cases this will not be enough.Worst case scenario, the solution in that case would be to split this into multiple projects, based on country or similar, and then just set up 8 projects with 8 connected workflows that would then load 8 jobs at the same time on the servers. This wo

433
JesperAndersen
QPN Level 4 ●●●●
6 months ago
C
carydean7
asked in Extension SDK
Not seeing my workflow Hello World (local) in list of tasks

I have gone through the Dev portal Hello World: Workflows Task tutorial and I am unable to see my Hello World in the list of tasks.  

1154
JesperAndersen
QPN Level 4 ●●●●
6 months ago
J
John Ndigirigi
asked in Extension SDK
Not seeing my Hello World (local plugin) workflow in the list of tasks

Hello everyone, I’m facing this  challenge right now. I’m Not seeing my Hello World (local) workflow in the list of tasks. I have tried all the solutions mentioned here on another post as well as followed the guide in the troubleshooting section unsuccessfully. I used the Hello World guide from the documentation to build a workflow task plugin. I will much appreciate your assistance.

230
J
6 months ago
JesperAndersen
QPN Level 4 ●●●●
JesperAndersenQPN Level 4 ●●●●
asked in Extension SDK
Issue with delete-participants API call in extension

For some reason I cannot get a “delete-participants” API call to work in my extension.I can make other calls work, so it is not the connection or authentication. I keep on getting a 500 (internal server error), unless if I deliberately configure the body as a string instead of an array, then I get a 400 error.I have tried all possible and impossible options to format the body, but a no point have I been successful in getting this to work from the extension. It is not a problem to get this to work from Postman, but running it from the extension just does not work.This is the simplified code (with project ID hidden):module.exports = async function(context) {    let getDeleteParticipants;        try {        const requestOptionsDelete = {            method: "POST",            body: ["DisableTestID"],              };        getDeleteParticipants = await context.client.qualtricsApiFetch('ex-projects/TS_……./delete-participants', requestOptionsDelete);        if (error.status === 201){      

563
JesperAndersen
QPN Level 4 ●●●●
7 months ago
JesperAndersen
QPN Level 4 ●●●●
JesperAndersenQPN Level 4 ●●●●
asked in Extension SDK
Faliure when using qualtricsScopes in manifest.json

Every time I try to add "qualtricsScopes" to a manifest.json file I get an error when I try to update another file in the same extension.There was not a qualtricsScope defined prior to this version (so error message is wrong)The error I get is:C:\Qualtrics\Extensions\change_user_status_5>xmt develop extensionSubmitting extension version 0.0.4-SNAPSHOT...Warning: submitting prerelease extension versions should be done through "xmt develop extension". Submitting prerelease versions with "xmt submit extension" will be disabled at a later datePreparing submission of extension EXT_fcbac855-8af0-400d-b9d4-c7db36cd25d8Submitted version 0.0.4-SNAPSHOT of extension EXT_fcbac855-8af0-400d-b9d4-c7db36cd25d8Submission ID: SUB_3fbd74e1-10af-499f-96e8-af1b2be4f899Note: This submission is for a snapshot version and should only be used for development purposes. Snapshot versions can be overwritten, and cannot be certified or published. To submit a non-snapshot version, do `xmt submit extension --re

423
JesperAndersen
QPN Level 4 ●●●●
8 months ago
JesperAndersen
QPN Level 4 ●●●●
JesperAndersenQPN Level 4 ●●●●
asked in Extension SDK
Where does the function client.getText get the labels from

This might be a super stupid question, but I have now spent several hours on this, and can’t seem to figure this one out on my own.In the different parts of the extension setup, the function client.getText(‘xyz’) is used to get a label returned that is matching the “xyz” value.When do I find and change the label for “xyz”?Thanks in advance!

241
qHubert
Qualtrics Employee
8 months ago
JesperAndersen
QPN Level 4 ●●●●
JesperAndersenQPN Level 4 ●●●●
asked in Extension SDK
Delete extension from developer portal

Is it possible to delete an extension from the developer portal?

574
JesperAndersen
QPN Level 4 ●●●●
9 months ago
NiC
QPN Level 5 ●●●●●
NiCQPN Level 5 ●●●●●
asked in Extension SDK
MD Extension with Embed Insight Plugin type

I am trying to create an XMD Extension with Embed Insight Plugin type.I followed the steps to create Oauth Client , gave the suggested scope.Got the bearer token.but when i try to retrive the Resource URL, i am getting error 403. I am following the steps and until Step 4 it goes as suggested (https://developer.qualtrics.com/developer/portal/documentation/96a4c909aa64d-hello-world-embed-insights#step-4---generate-a-dashboardwidget-temporary-session) but then i get 403 error with the following message{"meta": {"requestId": "1e4ba2b9-95b3-42ac-8aff-61ed3994cef6","httpStatus": "403 - Forbidden","error": {"errorCode": "EI_2.2","errorMessage": "You do not have permission to create this session"}}}

401
NiC
QPN Level 5 ●●●●●
9 months ago
NiC
QPN Level 5 ●●●●●
NiCQPN Level 5 ●●●●●
asked in Extension SDK
MD Extension with Embed Insight Plugin type.

I am trying to create an XMD Extension with Embed Insight Plugin type.I followed the steps to create Oauth Client , gave the suggested scope.Got the bearer token.but when i try to retrive the Resource URL, i am getting error 403. I am following the steps and until Step 4 it goes as suggested (https://developer.qualtrics.com/developer/portal/documentation/96a4c909aa64d-hello-world-embed-insights#step-4---generate-a-dashboardwidget-temporary-session) but then i get 403 error with the following message{"meta": {"requestId": "1e4ba2b9-95b3-42ac-8aff-61ed3994cef6","httpStatus": "403 - Forbidden","error": {"errorCode": "EI_2.2","errorMessage": "You do not have permission to create this session"}}}

140
NiC
QPN Level 5 ●●●●●
9 months ago
KyleK
Qualtrics Employee
KyleKQualtrics Employee
posted in Extension SDK
Interested in Learning about the Qualtrics Developer Platform? Join us for a 30-minute introductory webinar!

Hello everyone from Qualtrics Developer Corner 👋🏽 This Thursday at 9:00 am PDT, the Qualtrics Developer Relations team will be delivering a 30-minute webinar to help you ramp up on the Qualtrics Developer Platform!  We will cover high-level overviews of both the API and Extension SDK to give you a good idea of what they are and how they work. There will also be time for some Q&A at the end. If this is of interest to you, please register to attend via this link:https://qualtrics.zoom.us/webinar/register/6017016376702/WN_FAWSLJWDRHWx_nlaWfvrEg Feel free to share this link with interested coworkers as well 👍🏽

661
KyleK
Qualtrics Employee
9 months ago
C
Level 1 ●
corinallyLevel 1 ●
asked in Extension SDK
Extension reporting widget plugin does not appear when running in development

I am trying to run an extension locally using xmt develop extension, but the connection to localhost is refused, so the plugin is never displayed. I verified that I have added the XMT=1 query parameter, done a hard refresh, and that my browser (Edge) is configured to allow insecure content for my Qualtrics brand domain.This is my first time doing xmt develop extension, in the past the documentation used to say something like xmt run or xmt start I believe. Do you have any troubleshooting suggestions?  

743
V
9 months ago
qHubert
Qualtrics Employee
qHubertQualtrics Employee
posted in Extension SDK
Extension SDK Best Practices/Tips and Tricks

We have been working behind the scenes on the Extension SDK for a while now and there are a few things that have come up a number of times. This post will be geared towards aggregating best practices, so if you have any good tips or tricks while you are building, share them here with the rest of the community!Security:Security is our top priority and with the introduction of the SDK, we’re allowing you to integrate and introduce your own systems into the Qualtrics platform with relative ease. This means that we’re now sharing the security responsibilities. Be mindful of how your services are exposed and how you choose to show any embedded dashboards within your own systems. We support four authentication schemes: OAuth 2.0, Basic Authentication, API Key, and SFTP. Our recommendation is to use OAuth 2.0 as it has multiple advantages over the others. DevelopmentDuring development, use npm start or npm run build-dev because it generates unminified versions of your code. This makes it easi

1402
qHubert
Qualtrics Employee
11 months ago
R
romeoT
asked in Extension SDK
3rd party extension does not support workflow tasks

Hey,I’m currently trying to turn a rather complex survey project into a Solution extension in order to make a template out of it for future projects. However, since I imported the project into my solution extension, I get this error message when building the extension: 3rd-Party Extension is not allowed to use version of the following resources: [trigger.v0 trigger.v0 task.v0 task.v0 task.v0] I checked the tasks in question and they seem to be workflow tasks that I created, is it possible to keep them in the extension and fix this or do I need to remove them? 

483
TimR
QPN Level 4 ●●●●
11 months ago
TimR
QPN Level 4 ●●●●
TimRQPN Level 4 ●●●●
asked in Extension SDK
Solution CLI not installing?

tl;drWhen attempting to run solution init in my plugin folder, I’m getting the following:solution : The term 'solution' is not recognized as the name of a cmdlter, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again.At lin:1 char:1+ solution init+ ~~~~~~~~ + CategoryInfo : ObjectNotFound: (solution:String) [], CommandNotFoundException + FullyQualifiedErrorId : CommandNotFoundException BackgroundI’m going to preface by saying that I’ve gone through and successfully published an XM Solution to my sandbox brand once before using an individual installation of Node (didn’t use nvm). When I got on about a month later, I became aware of being out-of-date on Node, so after dealing with the unsurety of cleaning things up properly (uninstalling prior version of Node and using new one), I tried to remove all my prior setup and start clean with an nvm installation. Actions taken during

1946
TimR
QPN Level 4 ●●●●
1 year ago
D
DamienP
asked in Extension SDK
Solution execution step condition

Hi everyone,I'm trying to build my first xm solution extension.In my solutionExecution.json, i have multiple steps with a condition attribute like:"condition": "[setup.answers.Survey3, false]",https://developer.qualtrics.com/developer/portal/documentation/d78fd60a3162a-solution-execution#step-propertiesSurvey3 is checkbox defined in the setup.Build et validate are running ok but when i try the extension, i have an error on submitting the setup page : "There was a problem while trying to save the page. Please try again later or contact Qualtrics customer support."If i replace the condition with "condition": "true", there is no error.I tried with "condition": "[context.setup.answers.Survey3, false]" but the generated tests failed.I’m certainly doing something wrong but can’t find out what. Thanks, 

1215
D
1 year ago
C
Christopher E.
posted in Extension SDK
Installing CLI on windows is being blocked as severe virus threat.... real or false positive?

Is anyone else getting it?I tried both installing with NPM and direct exe and it blocked it both times with: trojan: Win32/Wacatac.H!ml  found in xmt.ext 

781
qHubert
Qualtrics Employee
1 year ago
R
Level 1 ●
r2rajcicLevel 1 ●
asked in Extension SDK
JS Webhook Causes Error During Survey

I am using a webhook in the JavaScript of one of my survey questions to export some survey data to Zapier (an automation engine). I am able to successfully send data out with the webhook, however, it then breaks the survey and I get the error “#B.1ykou2s.lnlu16va” shown below when I try to move on to the next question. Any thoughts on what could be the solution? Error after clicking “next” button to go to next survey question: My JavaScript code for the webhook is here: Qualtrics.SurveyEngine.addOnload(function(){ /*Place your JavaScript here to run when the page loads*/ var request = new XMLHttpRequest(); request.open("POST", "https://hooks.zapier.com/hooks/catch/xxxxxxx/xxxxxxx/", true); var params = { q_response_id: "${e://Field/ResponseID}", email: "${q://QID19/ChoiceTextEntryValue/4}", content: "example content", } request.send(JSON.stringify(params));}); Thanks.

633
R
Level 1 ●
1 year ago
L
LennyS
asked in Extension SDK
How to Pause & Resume a survey with a URL?

Hi,I would like to be able to pause (and resume) a survey with a URL. I want to use surveys to track attendance in my classes. Ideally, I would like to click a URL in a PowerPoint presentation to Activate ( or resume) a survey and then click another link a couple of minutes later to Pause the survey.Any thoughts…Thanks, Lenny

1260
L
1 year ago
qHubert
Qualtrics Employee
qHubertQualtrics Employee
posted in Extension SDK
Extension SDK Monthly Newsletter - September 2022

Key AnnouncementsCheck out the latest news and updates related to the Extension SDK Tooling, Extensibility, and Programs:______________________________________________________________________________Tooling Extension SDK Launch!  [Available]Leverage the Extension SDK for your production use casesThe Qualtrics Developer Platform team is pleased to announce the release of the Developer Portal and Extension SDK to all developers!You can build any of these plugins with the Extension SDK:[Available] Workflows Tasks to push Qualtrics data to other systems[Available] Workflows Events to initiate Qualtrics workflows from both custom internal or external events[Preview] Reporting Widgets to visualize custom data in Qualtrics dashboards[Preview] Survey Questions to collect data in novel ways and custom formatsLogin or Register on the Developer Portal______________________________________________________________________________Extensibility Streamlined Workflows Event   [Available]Create custom t

390
qHubert
Qualtrics Employee
2 years ago
qHubert
Qualtrics Employee
qHubertQualtrics Employee
posted in Extension SDK
Welcome and Introductions!

Hi and welcome to the brand new Extension SDK category! I’m Hubert and I’m one of the Developer Advocates on the Qualtrics Developer Platform team. Our team will be here to talk about new releases or use cases, get feedback, and to generally help out. What we really need is to hear from YOU on what you want to see here and what things we can do to improve our platform and engagement. We’re thinking about things like hackathons, featured extensions, and of course, badges, but there’s always more. Throw us your ideas!What can I do here? The category is for developers to chat, help each other out, and build community. Post your questions, answers, and feedback. RulesBe nice. We can’t help with operational support issues. If you have operational support issues, please work with our Qualtrics Support team.Where do we go from here?Well that’s up to you!Get your feet wet with the Extension SDK! Check out our Hello World getting started guides in the Developer PortalIf you’re new to our XM Com

400
qHubert
Qualtrics Employee
2 years ago

Motivational Playlist

Terms & Conditions