Rally UXR Webhook Event Types

This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.

participant.status_changed

Participant status changed. Ask Customer Support for Access.

Example

JSON

{
  "_eventType": "participant.status_changed",
  "participantId": "test_cm1uwhduy001vle4gr4soyqkq",
  "personId": "test_cm1uwhduy001vle4gr4soyqkq",
  "priorStatus": "INTERVIEW_INVITE_SENT",
  "status": "INTERVIEW_SCHEDULED",
  "studyId": "test_cm1uwhduy001vle4gr4soyqkq",
  "updatedAt": "2024-09-01T00:00:00Z"
}

person.opted_out

Person opted out of all communications.

Example

JSON

{
  "_eventType": "person.opted_out",
  "email": "dev@rallyuxr.com",
  "optedOut": true,
  "updatedAt": "2024-09-01T00:00:00.000Z"
}

person_import.api.finished

Person import from API finished.

Example

JSON

{
  "_eventType": "person_import.api.finished",
  "failedRecords": [
    {
      "personId": "test_cm1uwhduy001vle4gr4soyqkq"
    },
    {
      "email": "dev@rallyuxr.com"
    }
  ],
  "importId": "test_cm1uwhduy001vle4gr4soyqkq",
  "status": "COMPLETED",
  "updatedAt": "2024-09-01T00:00:00Z"
}