Skip to main content

RapidPro Adaptor

About RapidPro​

RapidPro is an open-source platform for building scalable, automated messaging workflows. It is widely used in development and humanitarian contexts for managing communication via SMS, social media, and other messaging channels.

Integration Options​

RapidPro supports two primary integration options:

1. Rest API: RapidPro has an available REST API that enables external services like OpenFn to pull data RapidPro, or push data from external apps to RapidPro. This option suits scheduled, bulk syncs or workflows that must update data in RapidPro with external information. See functions for more on how to use this adaptor to work with the API.

2. Webhook: RapidPro also has a Webhook or Data Forwarding to push data from Rapidpro to external systems. This option is suited for real-time, event-based data integration. Check out the RapidPro developer documentation to learn how to set up a webhook to push data to OpenFn.

Authentication​

When integrating with RapidPro via OpenFn, one primary authentication method is supported: Personal Access Token (PAT). See this adaptor's Configuration docs for more on required authentication parameters.

See platform docs on managing credentials for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:

{
  "host": "https://app.rapidpro.io/",
  "token": "#Super-sSCrecrete-token"
}
  1. RapidPro API documentation
  2. RapidPro Community

Implementation Examples​

  1. Sample RapidPro -> DHIS2 sync: https://github.com/OpenFn/rapidpro-dhis2

I've noticed a problem with this Adaptor, or something is out of date, what can I do?​

Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our Adaptors Wiki for more information on how you can update Adaptors!

Or, you can always reach out to the Community through our Community Forum here.