To learn more or to gain access to TurboVote Webhook events, contact your TurboVote Partner Manager, drop us a line or grab a time to meet.

Events emitted when a TurboVote user is created or updated in our system:

• User Created: Emitted when a TurboVote user is created in our system

• User Updated: Emitted when a TurboVote user is updated in our system

See the TurboVote Data Dictionary for details on fields returned by these events.

User Created

This event is emitted when a user is first created in the TurboVote system and assigned a unique identifier. The payload for a user creation event looks like the following:

{
 "version": "1",
 "type": "user.created",
 "data": {
  "id": "1234567890",
  "personalizationId": "ZScAnwr7RqKaIpvPFGpdPw",
  "voterbaseId: null, // always null
  "voterbaseCheckedAt: null, // always null
  "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"
 }
}

User Updated

This event is emitted when a user is updated in the TurboVote system. This may be due to an internal update during the user’s registration process, or it may be a user returning to the site to update their address or other information.

{
  "version": "1",
  "type": "user.updated",
  "data": {
    "user": {
      "id": "73c92af2-01a8-436d-a929-96009233db71",
      "personalizationId": "ZScAnwr7RqKaIpvPFGpdPw"
      "voterbaseId: "AK-12345678", // null unless user signs up to check registration and a voter record is found
      "voterbaseCheckedAt: "2024-08-27T18:42:48.158Z", // null unless user signs up and checks registration
      "firstName": "NewJohn",
      "middleName": "Doe",
      "lastName": "Smith",
      "preferredName": "Johnny",
      "dateOfBirth": "1990-01-01",
      "email": "john.doe@example.com",
      "phone": "+1234567890",
      "languagePreference": "en",
      "metadata": {
        "primary-key": "1234ABC"
      },
      "registeredAddress": {
        "line1": "124 Main Street",
        "line2": null,
        "city": "Newtown",
        "state": "CA",
        "zip": "91234"
      },
      "referralCode": "ABCD1234",
      "signedUpVia": "reminders",
      "partnerCommsOptIn": true, // optional Values include true null
      "createdAt": "2023-09-04T10:34:30Z",
      "updatedAt": "2023-09-20T11:23:34Z"
    },
    "previousUser": {
      "id": "73c92af2-01a8-436d-a929-96009233db71",
      "personalizationId": "ZScAnwr7RqKaIpvPFGpdPw"
      "firstName": "OldJohn",
      "middleName": "Doe",
      "lastName": "Smith",
      "preferredName": "Johnny",
      "dateOfBirth": "1990-01-01",
      "email": "john.doe@example.com",
      "phone": "+1234567890",
      "languagePreference": "en",
      "metadata": {
        "primary-key": "1234ABC"
      },
      "registeredAddress": {
        "line1": "123 Main Street",
        "line2": null,
        "city": "Anytown",
        "state": "CA",
        "zip": "91234"
      },
      "referralCode": "ABCD1234",
      "signedUpVia": "reminders",
      "partnerCommsOptIn": true, // optional Values include true null
      "createdAt": "2023-09-04T10:34:30Z",
      "updatedAt": "2023-09-04T10:34:30Z"
    }
  }
}