Skip to main content

OpenFn Adaptor

About OpenFn​

OpenFn is an open-source data integration platform designed to automate workflows and connect health and humanitarian systems. The platform enables organizations to build, deploy, and monitor automated data pipelines that sync data between different systems, trigger workflows based on incoming data, and transform information across various formats and standards.

Integration Options​

REST API: The OpenFn adaptor provides access to OpenFn's v1 API, enabling programmatic management of jobs, triggers, credentials, and workflow executions. This allows for automation of OpenFn platform operations, monitoring workflow performance, and integrating OpenFn capabilities into external applications and dashboards.

Authentication​

The OpenFn adaptor uses API token authentication to access the OpenFn platform:

{
  "baseUrl": "https://app.openfn.org",
  "access_token": "your_openfn_api_token"
}

Authentication Components:

  • baseUrl: The OpenFn platform URL (defaults to https://app.openfn.org)
  • access_token: Your OpenFn API token for authentication

API tokens can be generated from your OpenFn account settings and provide programmatic access to your projects and workflows.

Making API Requests​

// Get all jobs for a specific project
request({
  method: 'get',
  path: 'jobs',
  params: {
    project_id: 490,
  },
});

// Create a new job
request({
  method: 'post',
  path: 'jobs',
  data: {
    trigger_id: 1,
    expression: 'steps()',
  },
}, state => {
  console.log('Job created successfully!');
  return state;
});
Report or fix a problem with this adaptor

OpenFn adaptors are open source and we welcome contributions. See the Adaptors Wiki to learn how to update an adaptor, or ask on the OpenFn Community Forum.