> ## Documentation Index
> Fetch the complete documentation index at: https://botmesh.afaya.com.co/llms.txt
> Use this file to discover all available pages before exploring further.

# ConnectionUpdate

> Interface exported by @botmesh/core.

Defined in: [core/provider.ts:689](https://github.com/andresayac/botmesh/blob/main/packages/core/src/core/provider.ts#L689)

Payload of the `'connection'` event: the new state, the auth artifact while
authenticating (a QR string or a pairing code) and the reason when the connection closes.

## Properties

### state

```ts theme={null}
state: ConnectionState;
```

Defined in: [core/provider.ts:690](https://github.com/andresayac/botmesh/blob/main/packages/core/src/core/provider.ts#L690)

***

### authPayload?

```ts theme={null}
authPayload?: unknown;
```

Defined in: [core/provider.ts:696](https://github.com/andresayac/botmesh/blob/main/packages/core/src/core/provider.ts#L696)

Opaque, provider-rendered auth artifact for the UI layer: a QR string,
an OAuth URL, a pairing code, or undefined (token auth). Core never
interprets it — it forwards it to the host.

***

### reason?

```ts theme={null}
reason?: DisconnectReason;
```

Defined in: [core/provider.ts:697](https://github.com/andresayac/botmesh/blob/main/packages/core/src/core/provider.ts#L697)

***

### retryAfterMs?

```ts theme={null}
retryAfterMs?: number;
```

Defined in: [core/provider.ts:699](https://github.com/andresayac/botmesh/blob/main/packages/core/src/core/provider.ts#L699)

Advisory reconnect delay (ms) when reason === 'rateLimited'.

***

### detail?

```ts theme={null}
detail?: object;
```

Defined in: [core/provider.ts:700](https://github.com/andresayac/botmesh/blob/main/packages/core/src/core/provider.ts#L700)

#### code?

```ts theme={null}
code?: string | number;
```

#### message?

```ts theme={null}
message?: string;
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.