Skip to content

trackkit / providers/plausible/types / PlausibleEventPayload

Type Alias: PlausibleEventPayload

PlausibleEventPayload = object

Defined in: providers/plausible/types.ts:60

Plausible event payload sent to /api/event.

Properties

name

name: string

Defined in: providers/plausible/types.ts:63

Event name.


url

url: string

Defined in: providers/plausible/types.ts:65

URL associated with the event.


domain

domain: string

Defined in: providers/plausible/types.ts:67

Tracked domain.


referrer?

optional referrer: string

Defined in: providers/plausible/types.ts:71

Referrer URL.


props?

optional props: Record<string, string | number>

Defined in: providers/plausible/types.ts:73

Custom properties attached to the event.


revenue?

optional revenue: Revenue

Defined in: providers/plausible/types.ts:75

Revenue information (if revenue tracking enabled).


interactive?

optional interactive: boolean

Defined in: providers/plausible/types.ts:77

Whether the event was triggered by user interaction.

Released under the MIT License.