# @openfn/language-rapidpro

> OpenFn adaptor for RapidPro

Latest version **2.1.3** (published 2026-09-03) · LGPLv3 license · 0 weekly downloads

## Install

```sh
npm install @openfn/language-rapidpro
pnpm add @openfn/language-rapidpro
yarn add @openfn/language-rapidpro
bun add @openfn/language-rapidpro
```

## Health

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

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.1.3 |
| Published | 2026-09-03 |
| First published | 2021-09-12 |
| Weekly downloads | 0 |
| License | LGPLv3 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 80.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 26 |
| Author | Open Function Group |
| Maintainers | elias-ba, stuartc-openfn, taylordowns2000, mtuchi, jclark-openfn |

## Links

- npm: https://www.npmjs.com/package/@openfn/language-rapidpro
- Repository: https://github.com/openfn/adaptors
- Homepage: https://github.com/openfn/adaptors#readme
- Issues: https://github.com/openfn/adaptors/issues
- npm.io page: https://npm.io/package/@openfn/language-rapidpro

## Dependencies (2)

- [undici](https://npm.io/package/undici.md) ^7.29.0
- [@openfn/language-common](https://npm.io/package/@openfn/language-common.md) 3.3.5

## Recent versions

- 2.1.3 (latest) — 2026-09-03
- 2.1.2 — 2026-06-30
- 2.1.1 — 2026-05-27
- 2.1.0 — 2026-05-21
- 2.0.13 — 2026-05-20
- 2.0.12 — 2026-04-07
- 2.0.11 — 2026-03-30
- 2.0.10 — 2026-02-24
- 2.0.9 — 2026-01-30
- 2.0.8 — 2025-11-28
- 2.0.7 — 2025-11-12
- 2.0.6 — 2025-10-29
- 2.0.5 — 2025-10-16
- 2.0.4 — 2025-09-18
- 2.0.3 — 2025-09-01
- … 35 more at https://npm.io/package/@openfn/language-rapidpro/versions

## README

# language-rapidpro

An OpenFn **_adaptor_** for building integration jobs for use with the
[RapidPro API](https://rapidpro.io/api/v2/).

## Documentation

View the [docs site](https://docs.openfn.org/adaptors/packages/rapidpro-docs)
for full technical documentation.

## Usage

### Configuration

View all the required and optional properties for `state.configuration` in the
official
[configuration-schema](https://docs.openfn.org/adaptors/packages/rapidpro-configuration-schema/)
definition.

#### sample job expression using operation

```js
sendBroadcast({
  "text": "Hello friends.",
  "urns": [],
  "contacts": [],
  "groups", [],
});
```

### Key helper functions

**sendBroadcast(...) to send broadcast message to multiple contacts**

```js
sendBroadcast({
  text: 'Hello world',
  urns: ['twitter:sirmixalot'],
  contacts: ['a052b00c-15b3-48e6-9771-edbaa277a353'],
});
```

**startFlow(...) to trigger an automation flow in RapidPro**

```js
startFlow({
  flow: 'f5901b62-ba76-4003-9c62-72fdacc1b7b7',
  restart_participants: false,
  contacts: ['a052b00c-15b3-48e6-9771-edbaa277a353'],
});
```

**upsertContact(...) to update/insert a Contact (and check if exists using
external identifiers)**

```js
upsertContact({
  name: 'Mamadou',
  language: 'ENG',
  urns: ['tel:+250788123123'],
});
```

**addContact(...) to insert a Contact**

```js
addContact({
  name: 'Mamadou',
  language: 'ENG',
  urns: ['tel:+250788123123'],
});
```

## Development

Clone the [adaptors monorepo](https://github.com/OpenFn/adaptors). Follow the
`Getting Started` guide inside to get set up.

Run tests using `pnpm run test` or `pnpm run test:watch`

Build the project using `pnpm build`.

To just build the docs run `pnpm build docs`

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