Skip to main content

RegistrationPayload

Upgather Analytics

Upgather Analytics / RegistrationPayload

Interface: RegistrationPayload

Canonical payload shape for metricType: MetricType.registration events.

All fields are optional except url (inherited from MetricPayload). This mirrors the AIWeek/CyberWeek "Get your pass" registration form. Field names align with the analytics-service safelist; consumers may extend with additional fields per MetricPayload's open shape, but those will be dropped by the service safelist unless explicitly added there.

Note: the form's "workPhone" field should be sent as phone to align with the safelist + DTO + PII encryption policy, which treat phone as a single canonical field.

Extends​

Indexable​

[key: string]: unknown

Properties​

attendeeType?​

optional attendeeType: string

company?​

optional company: string

country?​

optional country: string

email?​

optional email: string

error?​

optional error: string

firstName?​

optional firstName: string

formSource?​

optional formSource: "modal" | "events" | "host"

jobTitle?​

optional jobTitle: string

lastName?​

optional lastName: string

phone?​

optional phone: string

receiveUpdates?​

optional receiveUpdates: boolean

state?​

optional state: string

success?​

optional success: boolean

url​

url: string

The canonical page URL where the event occurred. For client-side events, this should be window.location.href or similar. For server-side events, provide the most specific URL relevant to the action.

Inherited from​

MetricPayload.url

zipCode?​

optional zipCode: string