# Interface: ReferralEvent

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:109

## Properties

### from?

> `optional` **from?**: `string`

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:116

`changed` only — the previous partner code.

***

### holdout

> **holdout**: `boolean`

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:112

***

### referral

> **referral**: [`Referral`](https://plandalf.com/docs/packages/sdk/interfaces/Referral) \| `null`

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:111

***

### restored?

> `optional` **restored?**: `boolean`

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:118

`captured` only — true when restored from storage rather than a new click.

***

### target?

> `optional` **target?**: `"badge"` \| `"cta"`

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:120

`click` only — which part of the badge was clicked.

***

### type

> **type**: [`ReferralEventType`](https://plandalf.com/docs/packages/sdk/type-aliases/ReferralEventType)

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:110

***

### variant?

> `optional` **variant?**: [`BadgeVariant`](https://plandalf.com/docs/packages/sdk/type-aliases/BadgeVariant)

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/referral.ts:114

Badge events only.

Source: https://plandalf.com/docs/packages/sdk/interfaces/ReferralEvent