---
url: https://docs.ridgedata.ai/reference/embed-api/Variable.EmbedMessage.md
---
# Variable: EmbedMessage

```ts
const EmbedMessage: object;
```

Iframe message names, prefixed with `ridge:` to distinguish them from other window messages.
Grouped by direction: messages sent by the host page, then messages sent by the embed.

## Type Declaration

### error

```ts
readonly error: "ridge:error" = "ridge:error";
```

embed → host: a state update was rejected and did not take effect.

Sent once per rejected component id. Other updates in the batch may succeed.
`setState` does not send a separate reply.

### getState

```ts
readonly getState: "ridge:getState" = "ridge:getState";
```

host → embed: ask for the current state.

### getStateSchema

```ts
readonly getStateSchema: "ridge:getStateSchema" = "ridge:getStateSchema";
```

host → embed: ask for the complete component state schema.

### ready

```ts
readonly ready: "ridge:ready" = "ridge:ready";
```

embed → host: ready to receive state requests, with the complete state schema.

### setState

```ts
readonly setState: "ridge:setState" = "ridge:setState";
```

host → embed: merge this state, per id and per key. `null` clears a key.

### state

```ts
readonly state: "ridge:state" = "ridge:state";
```

embed → host: reply to `getState`.

### stateChange

```ts
readonly stateChange: "ridge:stateChange" = "ridge:stateChange";
```

embed → host: state changed through a user edit or a non-silent `setState`.

### stateSchema

```ts
readonly stateSchema: "ridge:stateSchema" = "ridge:stateSchema";
```

embed → host: reply to `getStateSchema`.