Participant Status Changed - Rally Developer Docs

This webhook is triggered when a participant’s status changes. Note: This webhook requires a feature flag. Ask Customer Support for access.

string

required

The type of event. For this webhook, it is always participant.status_changed.

string

required

Unique identifier of the participant.

string

required

Unique identifier of the person.

string

required

Unique identifier of the study.

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.

string

required

Prior status of the participant. Null if the participant was just created. Possible values are the same as status.

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"
}