# botframework-schema

> Activity schema for the Microsoft Bot Framework.

Latest version **4.23.3** (published 2025-08-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install botframework-schema
pnpm add botframework-schema
yarn add botframework-schema
bun add botframework-schema
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 4.23.3 |
| Published | 2025-08-27 |
| First published | 2018-02-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 776.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 724 |
| Author | Microsoft Corp. |
| Maintainers | botframework, sgellock, cwhitten |
| Keywords | botconnector, bots, chatbots |

## Links

- npm: https://www.npmjs.com/package/botframework-schema
- Repository: https://github.com/Microsoft/botbuilder-js
- Homepage: http://github.com/Microsoft/botbuilder-js
- Issues: http://github.com/Microsoft/botbuilder-js/issues
- npm.io page: https://npm.io/package/botframework-schema

## Dependencies (3)

- [zod](https://npm.io/package/zod.md) ^3.23.8
- [uuid](https://npm.io/package/uuid.md) ^10.0.0
- [adaptivecards](https://npm.io/package/adaptivecards.md) 1.2.3

## Recent versions

- 4.23.3 (latest) — 2025-08-27
- 4.23.0-dev.20240405 (next) — 2024-04-05
- 4.12.1 (patch) — 2021-06-16
- 4.23.3-dev — 2025-08-19
- 4.17.0-blobs1 — 2025-06-10
- 4.24.0-dev2 — 2025-04-09
- 4.24.0-dev1 — 2025-04-07
- 4.23.3-dev2 — 2025-02-12
- 4.23.3-dev1 — 2025-02-11
- 4.23.2 — 2025-02-06
- 4.23.2-rc2 — 2025-02-03
- 4.23.2-dev1 — 2024-12-10
- 4.24.0-rc1 — 2024-10-16
- 4.23.1 — 2024-09-23
- 4.23.0 — 2024-08-28
- … 538 more at https://npm.io/package/botframework-schema/versions

## README

Activity schema for the Microsoft Bot Framework.

- [Installing](#installing)
- [Documentation](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-overview-introduction?view=azure-bot-service-4.0)
- [GitHub Repo](https://github.com/Microsoft/botbuilder-js)
- [Report Issues](https://github.com/Microsoft/botbuilder-js/issues)

## Installing
To add the preview version of this package to your bot be sure include the @preview tag:

```bash
npm install --save botframework-schema@preview
```

While this package is in preview it's possible for updates to include build breaks. To avoid having any updates break your bot it's recommended that you update the dependency table of your bots `package.json` file to lock down the specific version of the package you're using:

```JSON
{
    "dependencies": {
        "botbuilder": "4.0.0-preview1.2",
        "otframework-schema": "4.0.0-preview1.2"
    }
}
```

---
_Source: https://npm.io/package/botframework-schema · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._