Skip to main content
WEBHOOK
participant.status_changed
{
  "_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"
}

Body

application/json
​
_eventType
enum<string>
required
Available options:
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
enum<string>
required

New status of the participant.

Available options:
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
enum<string> | null
required

Prior status of the participant. Null if the participant was just created.

Available options:
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
​
updatedAt
string<date-time>
required

Timestamp the participant status changed.

Response

200

Success