Skip to main content

HTTP Adaptor

About the HTTP "universal" adaptor​

Communicate with web apps using HTTP (HyperText Transfer Protocol). This adaptor enables out-of-box integration with any REST API!

Integration Options​

Use this adaptor to communicate with any REST API or any other app that can communicate via HTTP.

Note that OpenFn also supports Webhooks, but that is a workflow trigger type (see docs), not an adaptor.

Authentication​

HTTP itself does not enforce authentication, but many applications that use HTTP implement security mechanisms to control access. Common methods that can be used when integrating with OpenFn include Basic Authentication, API Keys and OAuth. See this adaptor's Configuration docs for more on the 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:

{
  "username": "test@openfn.org",
  "password": "@some(!)Password",
  "access_token": "00QCjAl4MlV-WPX",
  "baseUrl": "https://instance_name.surveycto.com"
}

Implementation Examples​

  1. UNICEF Primero - UNHCR Progres Interoperability: https://github.com/OpenFn/primero-progres
  2. UNICEF Thailand Primero Interoperability: https://openfn.github.io/primero-thailand/

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.