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

# IDashboardEvent

- 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

Base type for all dashboard events.

**Signature:**

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

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [correlationId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardevent/index.md#idashboardeventcorrelationid) | `readonly` | string | _(Optional)_ If this event was triggered as part of a command processing, then the prop will contain command's correlation ID. |
| [ctx](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardevent/index.md#idashboardeventctx) | `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.idashboardevent/index.md#idashboardeventmeta) | `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.idashboardevent/index.md#idashboardeventpayload) | `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.idashboardevent/index.md#idashboardeventtype) | `readonly` | [DashboardEventType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardeventtype/index.md) | Event type. Always starts with "GDC.DASH/EVT". |

## Property details

### IDashboardEvent.correlationId

If this event was triggered as part of a command processing, then the prop will contain command's correlation ID.

**Signature:**

```typescript
readonly correlationId?: string;
```

### IDashboardEvent.ctx

Dashboard context in which the event occurred.

**Signature:**

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

### IDashboardEvent.meta

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

**Signature:**

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

### IDashboardEvent.payload

Specify any additional data the custom event needs.

**Signature:**

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

### IDashboardEvent.type

Event type. Always starts with "GDC.DASH/EVT".

**Signature:**

```typescript
readonly type: DashboardEventType;
```