To learn more or to gain access to TurboVote Webhook events, contact your TurboVote Partner Manager or email partnerships@democracy.works.
This user engagement event is emitted when a user checks their registration status using TurboVote.
{
"specversion": "1.0"
"type": "org.turbovote.user.voter-registration-check-completed.v1",
"source": "/turbovote/webhook",
"time": "2024-04-01T11:12:13Z",
"data": {
// User that triggered the event, if known
"user": {
"id": "73c92af2-01a8-436d-a929-96009233db71",
"hostname": "example.turbovote.org",
"personalizationId": "ZScAnwr7RqKaIpvPFGpdPw"
"firstName": "John",
"middleName": "Doe",
"lastName": "Smith",
"preferredName": "Johnny",
"dateOfBirth": "1990-01-01",
"email": "john.doe@example.com",
"phone": "+1234567890",
"languagePreference": "en",
"registeredAddress": {
"line1": "123 Main Street",
"line2": null,
"city": "Anytown",
"state": "CA",
"zip": "91234"
},
"referralCode": "ABCD1234",
"embedPlacement": "homepage",
"metadata": {
"primary-key": "1234ABC",
"secondary-key": "1234ABC",
"other-key": "1234ABC"
},
"signedUpVia": "reminders",
"partnerCommsOptIn": true, // optional Values include true null
"createdAt": "2023-09-04T10:34:30Z",
"updatedAt": "2023-09-04T10:34:30Z"
},
// Event-specific fields
"tool": "turbovote",
"source": "targetsmart-api",
"voterFileUpdateDate": "2024-03-01",
"matched": true, // or false
// These fields are only returned if "match" is true
"registrationStatus": "registered", // optional
"voterStatus": "inactive", // optional
"voterbaseId": "AK-12345678" // optional
}
}User Engagement Event-specific Fields
In addition to user profile fields, this event includes fields related to the user's registration status:
| Field | Description | Value | Value Example |
|---|---|---|---|
| tool | Application emitting event | TurboVote | turbovote |
| source | Source of user’s voter and voter registration status details | targetsmart-api | targetsmart-api |
| matched | Results of TargetSmart Voter Registration Service database of registered voters query |
Matches single voter file record. User deemed registered to vote. The following fields returned: registrationStatus voterStatus voterbaseId |
true |
| 0 or 2+ matches. | false | ||
| registrationStatus | User’s voter registration status (optional) | Registered to vote | registered |
| voterStatus | User’s voter status (optional) | Active voter | active |
| Inactive voter | inactive | ||
| Unavailable | unknown | ||
| voterbaseId | User’s ID in Voterbase - TargetSmart’s voter file. | VoterBase ID | AK-12345678 |
| voterFileUpdateDate | Date voter file is received from the state. Most recent registration date on the file. | YYYY-MM-DD | 2024-03-01 |
| personalizationId | TurboVote personalization ID used to personalize TurboVote web experiences when passed along as the value of the user query parameter | TurboVote personalization ID | ZScAnwr7RqKaIpvPFGpdPw |