Third-party Platform Integration with the WeJot Panel

Audience: survey or sample platforms that send their own respondents to WeJot Panel tasks Updated: 2026-10-30

1. Integration model

Third-party platform integration is a different flow from a researcher’s self-serve external survey link.

Item	Researcher external link	Third-party platform integration
Initiated by	Researcher creates it in a WeJot conversation	Platform integration
Respondent source	WeJot Panel	Platform’s own respondents
Result matching	Respondent code + manual submission on the task page	`code` + `result` status callback

The integration flow:

WeJot provides a task entry link with a deploy token.
The platform sends the respondent to that link. The WeJot task page shows the respondent’s unique code.
The platform stores that code in its survey.
At the end of the survey, the platform redirects to a WeJot status URL based on the outcome.
WeJot records the terminal state and shows the result page.

If you are a researcher launching a third-party survey on the WeJot Panel, read External Survey Links for WeJot Panel.

2. Before you start

Your platform can store each respondent’s code and pass it back unchanged in the final redirect.
Your platform can configure different redirect URLs for different outcomes.
Redirect URLs use HTTPS.
Run an end-to-end test with a WeJot test task before switching to production.
Do not expose the respondent code in public pages, logs, or places other respondents can access.

3. Passing the respondent code

WeJot generates the unique code when the respondent enters the task. When the third-party survey opens, WeJot automatically appends responseCode=<code> to the URL, along with the agentPID tracking parameter.

The platform should read and store responseCode on entry, then pass it back unchanged as code. If the platform cannot read URL parameters, add a required single-line text question as a fallback so the respondent can paste the code from the WeJot task page.

responseCode and agentPID are appended by WeJot. The platform must not remove or overwrite them. code must be the value of responseCode, not the platform’s own response ID, answer ID, or user ID.

URL-encode the code before adding it to the callback URL.

4. Four status callback URLs

Production:


Complete:
https://wj.pro/api/sample/task/external/status?result=complete&code={responseCode}&taskId={agentPID}

Over quota:
https://wj.pro/api/sample/task/external/status?result=overquota&code={responseCode}&taskId={agentPID}

Screened out:
https://wj.pro/api/sample/task/external/status?result=screened&code={responseCode}&taskId={agentPID}

Quality rejected:
https://wj.pro/api/sample/task/external/status?result=quality&code={responseCode}&taskId={agentPID}

4.1 Parameters

Parameter	Required	Description
`code`	Yes	The `responseCode` appended by WeJot, i.e. the unique respondent code
`result`	Yes	`complete`, `overquota`, `screened`, or `quality`
`taskId`	No	The `agentPID` appended by WeJot (task ID); pass it back when available

taskId is optional. When present, use the agentPID value to help WeJot troubleshoot.

4.2 Outcomes

`result`	Platform scenario	WeJot handling
`complete`	Respondent finished the full survey	Enters WeJot quota allocation; counted as a valid response and enters the reward flow when eligible
`overquota`	Platform quota is full	Recorded as an over-quota terminal state; not counted as a valid response and no reward is generated
`screened`	Respondent did not pass screening	Recorded as screened out; not counted as a valid response and no reward is generated
`quality`	Platform rejected the response for quality	Recorded as quality rejected; not counted as a valid response and no reward is generated

complete still goes through WeJot quota checks. If the WeJot task is already full, it is handled as over quota.

5. Setup steps

Contact WeJot to enable third-party platform integration and obtain a test task and task entry link.
Add respondent-code collection to your survey and make sure every code is stored.
Configure four redirect URLs in your survey’s end logic for complete, over quota, screened out, and quality rejected.
Put the respondent code in the code parameter and URL-encode it.
Run all four outcomes against the test task and confirm the matching states appear in WeJot response data.
Switch to the production task and domain after the test passes.

6. Result page and idempotency

All four outcomes return a respondent-facing result page. Complete shows the reward card; the other three show the corresponding end page.
Repeated callbacks for the same respondent code are idempotent and do not duplicate collection counts, quota usage, or rewards.
If the respondent already submitted completion on the WeJot task page, a later terminal callback is treated as already submitted and does not change the result again.
An invalid or missing code, or an unrecognized result value, returns an error page without changing the response state.

7. FAQ

The callback says the respondent code is invalid

Make sure code is the code shown on the WeJot task page, not your platform’s answer ID or user ID. The code must match the task and respondent.

Can I omit taskId?

Yes. Respondent codes are globally unique, and WeJot uses the code to find the task. taskId is only for troubleshooting.

Will a duplicate callback issue a duplicate reward?

No. Repeated callbacks for the same respondent code are idempotent.

What if the result page does not open?

Check the code and result values first, then confirm your platform is using the callback domain for the correct environment. If it still fails, contact WeJot support.

8. Integration checklist

The platform has the test task entry link.
The respondent can see the code on the WeJot task page.
The survey stores the code and passes it back as code.
All four callback URLs are configured with complete, overquota, screened, and quality.
Each outcome has been tested and appears correctly in WeJot response data.
A duplicate callback has been tested and does not duplicate collection or rewards.
The production domain and task are configured before launch.