# @amplitude/plugin-custom-enrichment-browser

Latest version **0.1.22** (published 2026-08-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @amplitude/plugin-custom-enrichment-browser
pnpm add @amplitude/plugin-custom-enrichment-browser
yarn add @amplitude/plugin-custom-enrichment-browser
bun add @amplitude/plugin-custom-enrichment-browser
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.1.22 |
| Published | 2026-08-24 |
| First published | 2026-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 63 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 181 |
| Author | Amplitude Inc |
| Maintainers | curtisbliu, kelson.warner, sdk.dev, eric_amplitude, daniel-graham-amplitude, jjwang123 |

## Links

- npm: https://www.npmjs.com/package/@amplitude/plugin-custom-enrichment-browser
- Repository: https://github.com/amplitude/Amplitude-TypeScript
- Issues: https://github.com/amplitude/Amplitude-TypeScript/issues
- npm.io page: https://npm.io/package/@amplitude/plugin-custom-enrichment-browser

## Dependencies (2)

- [tslib](https://npm.io/package/tslib.md) ^2.4.1
- [@amplitude/analytics-core](https://npm.io/package/@amplitude/analytics-core.md) 2.55.0

## Recent versions

- 0.1.22 (latest) — 2026-08-24
- 0.1.23-video-analytics-2.0 (video-analytics-2) — 2026-09-09
- 0.1.21-video-analytics.0 (video-analytics) — 2026-07-31
- 0.1.12-featelement-selector-v1.0 (featelement-selector-v1) — 2026-06-15
- 0.1.11-SR-4497-custom-transport-hooks.0 (SR-4497-custom-transport-hooks) — 2026-06-09
- 0.1.10-sr-perf-reliability-rc.0 (sr-perf-reliability-rc) — 2026-06-05
- 0.1.10-sr-4646-rc.0 (sr-4646-rc) — 2026-06-03
- 0.1.9-sr-idb-multitab-test-rc.0 (sr-idb-multitab-test-rc) — 2026-05-04
- 0.1.6-sr-3531-rc-2.0 (sr-3531-rc-2) — 2026-04-20
- 0.1.4-SR-3115-rc2.0 (SR-3115-rc2) — 2026-04-08
- 0.1.4-SR-3115-rc1.0 (SR-3115-rc1) — 2026-04-03
- 0.1.4-SR-3115.0 (SR-3115) — 2026-04-03
- 0.1.21 — 2026-08-12
- 0.1.20 — 2026-07-28
- 0.1.19 — 2026-07-22
- … 21 more at https://npm.io/package/@amplitude/plugin-custom-enrichment-browser/versions

## README

<p align="center">
  <a href="https://amplitude.com" target="_blank" align="center">
    <img src="https://static.amplitude.com/lightning/46c85bfd91905de8047f1ee65c7c93d6fa9ee6ea/static/media/amplitude-logo-with-text.4fb9e463.svg" width="280">
  </a>
  <br />
</p>

# @amplitude/plugin-custom-enrichment-browser

Official Browser SDK plugin for custom enrichment

## Installation

This package is published on NPM registry and is available to be installed using npm and yarn.

```sh
# npm
npm install @amplitude/plugin-custom-enrichment-browser

# yarn
yarn add @amplitude/plugin-custom-enrichment-browser
```

## Usage

This plugin works on top of Amplitude Browser SDK and allows the user to execute custom functionality on their events. To use this plugin, you need to install `@amplitude/analytics-browser` version `v2.0.0` or later.

### 1. Import Amplitude packages

* `@amplitude/plugin-custom-enrichment-browser`

```typescript
import { customEnrichmentPlugin } from '@amplitude/plugin-custom-enrichment-browser';
```

### 2. Instantiate custom enrichment plugin
```typescript
const customEnrichmentPlugin = customEnrichmentPlugin();
```

#### Options


### 3. Install plugin to Amplitude SDK

```typescript
amplitude.add(customEnrichmentPlugin);
```

### 4. Initialize Amplitude SDK

```typescript
amplitude.init('API_KEY');
```

## Result
This plugin executes a user-defined script, defined within Amplitude Remote Configuration Settings.

#### Event type
* No event type added

#### Event properties
* Defined by user

---
_Source: https://npm.io/package/@amplitude/plugin-custom-enrichment-browser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
