Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rallyuxr.com/llms.txt

Use this file to discover all available pages before exploring further.

This webhook is triggered when a participant’s status changes. Note: This webhook requires a feature flag. Ask Customer Support for access.
​
_eventType
string
required
The type of event. For this webhook, it is always participant.status_changed.
​
participantId
string
required
Unique identifier of the participant.
​
personId
string
required
Unique identifier of the person.
​
studyId
string
required
Unique identifier of the study.
​
status
string
required
New status of the participant. Possible values are NOT_STARTED, INVITE_SENT, NOT_ELIGIBLE, SCREENER_STARTED, SCREENER_COMPLETED, SCREENER_QUALIFIED, SCREENER_DISQUALIFIED, INTERVIEW_INVITE_SENT, INTERVIEW_SCHEDULED, INTERVIEW_COMPLETED, INTERVIEW_CANCELLED, INTERVIEW_NO_SHOWED, SURVEY_STARTED, SURVEY_COMPLETED, INCENTIVE_SENT, INCENTIVE_CLAIMED, INCENTIVE_SKIPPED, UNMODERATED_TEST_INVITE_SENT, UNMODERATED_TEST_STARTED, UNMODERATED_TEST_COMPLETED, COMPLETED_STUDY, CANCELLED, OPTED_OUT, EMAIL_SOFT_BOUNCED, EMAIL_HARD_BOUNCED.
​
priorStatus
string
required
Prior status of the participant. Null if the participant was just created. Possible values are the same as status.
​
updatedAt
string
required
Timestamp the participant status changed.
Example Payload: 
{
  "_eventType": "participant.status_changed",
  "participantId": "test_cm1uwhduy001vle4gr4soyqkq",
  "personId": "test_cm1uwhduy001vle4gr4soyqkq",
  "studyId": "test_cm1uwhduy001vle4gr4soyqkq",
  "status": "INTERVIEW_SCHEDULED",
  "priorStatus": "INTERVIEW_INVITE_SENT",
  "updatedAt": "2024-09-01T00:00:00Z"
}