> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# ICustomDashboardEvent

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/model/events/base.ts
- Guides: [Handle dashboard events](https://www.gooddata.ai/docs/gooddata-ui/latest/dashboard-plugins/dashboard-events/index.md)

Base type for all custom events.

**Signature:**

```typescript
export interface ICustomDashboardEvent<TPayload = any> 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [ctx](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.icustomdashboardevent/index.md#icustomdashboardeventctx) | `readonly` | [DashboardContext](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardcontext/index.md) | Dashboard context in which the event occurred. |
| [meta?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.icustomdashboardevent/index.md#icustomdashboardeventmeta) | `readonly` | { acceptedTimestamp: number; } | _(Optional)_ Metadata about the event useful for logging and handling of the event. |
| [payload?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.icustomdashboardevent/index.md#icustomdashboardeventpayload) | `readonly` | TPayload | _(Optional)_ Specify any additional data the custom event needs. |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.icustomdashboardevent/index.md#icustomdashboardeventtype) | `readonly` | string | Event type. Always starts with "CUSTOM/EVT". |

## Property details

### ICustomDashboardEvent.ctx

Dashboard context in which the event occurred.

**Signature:**

```typescript
readonly ctx: DashboardContext;
```

### ICustomDashboardEvent.meta

Metadata about the event useful for logging and handling of the event.

**Signature:**

```typescript
readonly meta?: {
        acceptedTimestamp: number;
    };
```

### ICustomDashboardEvent.payload

Specify any additional data the custom event needs.

**Signature:**

```typescript
readonly payload?: TPayload;
```

### ICustomDashboardEvent.type

Event type. Always starts with "CUSTOM/EVT".

**Signature:**

```typescript
readonly type: string;
```