Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,15 @@ served using any static contents hosting service.
Builds to `main` will automatically be deployed to
[docs.openfn.org](https://docs.openfn.org). This branch is protected, but we
welcome pull requests!


### To add help sections to all adaptor files:
```bash
yarn run add-help-sections
# or
node scripts/add-help-section.js
```

### For new adaptor files:
When creating new adaptor documentation files, make sure to run `npm run add-help-sections` to add the standard help section.

4 changes: 3 additions & 1 deletion adaptors/asana.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag

1. The Wildlife Conservation Society (WCS) - KoboToolBox -> GoogleSheets -> Asana sync: [https://openfn.github.io/ConSoSci/asana/](https://openfn.github.io/ConSoSci/asana/)

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
4 changes: 3 additions & 1 deletion adaptors/azure-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag

_Coming soon!_

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
4 changes: 3 additions & 1 deletion adaptors/beyonic.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag

_Coming soon!_

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
4 changes: 3 additions & 1 deletion adaptors/bigquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag

_Coming soon!_

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
42 changes: 42 additions & 0 deletions adaptors/cartodb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: CartoDB (CARTO) Adaptor
---

## About CartoDB

CARTO (formerly CartoDB) is a cloud-native spatial intelligence platform that enables organizations to unlock the power of location data. Built to work natively with major cloud data warehouses like Google BigQuery, Snowflake, Amazon Redshift, and Databricks, CARTO provides advanced geospatial analysis, visualization, and app development capabilities without requiring data movement or ETL processes. The platform serves data analysts, developers, and GIS professionals with tools for spatial analytics, interactive mapping, and location intelligence.

## Integration Options

CartoDB supports REST API integration with OpenFn:

**REST API**: CartoDB provides a comprehensive SQL API that enables external services like OpenFn to interact with geospatial datasets. This API allows you to execute SQL queries, insert/update spatial data, and perform complex geospatial analyses programmatically. The integration is suited for scheduled data synchronization, bulk geospatial operations, and workflows that need to update CartoDB datasets with external spatial information. See [functions](/adaptors/packages/cartodb-docs) for more on how to use this adaptor to work with the CartoDB SQL API.

## Authentication

To connect to CartoDB, you need to provide your account credentials:

```json
{
"account": "your_carto_username",
"apiKey": "your_api_key_here"
}
```

**Required Fields:**
- `account`: Your CARTO account username (required)
- `apiKey`: Your CARTO API key for authentication (required)

You can obtain your API key from your CARTO account dashboard under API Keys section.


## Helpful Links

- [CARTO API Reference](https://api-docs.carto.com/)
- [OpenFn CartoDB Adaptor](https://docs.openfn.org/adaptors/packages/cartodb-readme)

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
6 changes: 6 additions & 0 deletions adaptors/chatgpt.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,9 @@ technical docs on the authentication parameters required.
- About ChatGPT: https://chatgpt.com/
- API docs: https://platform.openai.com/docs/overview
- API Intro: https://www.chatbase.co/blog/chatgpt-api

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
6 changes: 6 additions & 0 deletions adaptors/cht.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,9 @@ this:
- API Docs: https://docs.communityhealthtoolkit.org/building/reference/api/
- CHT Docs: https://docs.communityhealthtoolkit.org/
- CHT Community: https://forum.communityhealthtoolkit.org/

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
6 changes: 6 additions & 0 deletions adaptors/ckan.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,3 +221,9 @@ to access the web API.
CKAN has been implemented in [catalog.data.gov](https://catalog.data.gov),
[open.canada.ca/data](https://open.canada.ca/data), and
[data.humdata.org](https://data.humdata.org).

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
6 changes: 6 additions & 0 deletions adaptors/claude.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,9 @@ technical docs on the authentication parameters required.

- About Claude: https://claude.ai/
- API docs: https://www.anthropic.com/api

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
6 changes: 6 additions & 0 deletions adaptors/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,3 +349,9 @@ And make sure that any steps which use collections have multiple adaptors set:
}
}
```

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
6 changes: 6 additions & 0 deletions adaptors/commcare.md
Original file line number Diff line number Diff line change
Expand Up @@ -347,3 +347,9 @@ CommCare has different APIs for reading vs. modifying data. Some helpful links:
https://github.com/OpenFn/miracle-feet
- Lwala (CommCare-Salesforce 2-way sync): https://github.com/OpenFn/lwala
- myAgro (CommCare-Salesforce): https://github.com/OpenFn/myagro-commcare-sf

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
6 changes: 6 additions & 0 deletions adaptors/common.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,9 @@ each(
})
);
```

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
7 changes: 7 additions & 0 deletions adaptors/dhis2.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,10 @@ useful. In the following sections, special systems will be described.
1. DHIS2 Demo Implementations: https://github.com/OpenFn/dhis2-demo
2. Lesotho Integration connecting two DHIS2 instances:
https://github.com/OpenFn/lesotho-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](https://github.com/OpenFn/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](https://community.openfn.org/).
45 changes: 45 additions & 0 deletions adaptors/divoc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Divoc Adaptor
---

## About Divoc

DIVOC (Digital Infrastructure for Verifiable Open Credentialing) is an open-source platform designed for issuing and managing digital vaccination certificates. Developed by the eGovernments Foundation and used as the backbone for India's CoWIN platform, DIVOC has issued over 2 billion vaccination certificates across multiple countries including India, Sri Lanka, Philippines, Jamaica, and Indonesia. The platform provides WHO-compliant digital certificates that are accepted in over 120 countries worldwide.

## Integration Options

DIVOC supports REST API integration with OpenFn:

**REST API**: DIVOC provides a comprehensive REST API that enables external services like OpenFn to interact with vaccination certificate management systems. This API allows you to create digital certificates, manage vaccination facilities, register beneficiaries, and generate vaccination reports programmatically. The integration is suited for scheduled certificate issuance, bulk vaccination data synchronization, and workflows that need to update DIVOC with external health system information. See [functions](/adaptors/packages/divoc-docs) for more on how to use this adaptor to work with the DIVOC API.

## Authentication

To connect to DIVOC, you need to provide authentication credentials:

```json
{
"baseUrl": "https://your-divoc-instance.example.com",
"access_token": "your_bearer_token_here",
"username": "your_username",
"password": "your_password"
}
```

**Required Fields:**
- `baseUrl`: The base URL of your DIVOC instance
- `username`: Your DIVOC username (required)
- `password`: Your DIVOC password (required)

**Optional Fields:**
- `access_token`: Bearer token for API authentication (can be used instead of username/password)


## Helpful Links

- [OpenFn DIVOC Adaptor](https://docs.openfn.org/adaptors/packages/divoc-readme)

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
4 changes: 3 additions & 1 deletion adaptors/dynamics.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag

_Comming soon!_

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
41 changes: 41 additions & 0 deletions adaptors/facebook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Facebook Adaptor
---

## About Facebook

[Facebook](https://www.facebook.com/) is the world's largest social networking platform, connecting billions of people globally. Facebook provides various APIs and integration capabilities, particularly through Facebook Messenger, enabling businesses to create automated messaging experiences, customer service bots, and interactive communication workflows.

The Facebook Messenger platform is particularly valuable for businesses seeking to provide customer support, marketing automation, and interactive customer engagement through one of the world's most popular messaging platforms.

## Integration Options

**Messenger API**: Facebook provides the Messenger Platform API that enables businesses to send messages, create interactive experiences, and build chatbots. The API supports rich messaging features including text, images, quick replies, and structured templates for creating engaging user interactions through Facebook Messenger.

## Authentication

Facebook uses OAuth 2.0 access tokens for Messenger API authentication:

```json
{
"access_token": "EAAGm0PX4ZCpsBAEHuZBwZBZCDEZDZD7ZC8ZBZBt7MbZA7sVZA"
}
```

**Authentication Components:**
- **access_token**: Facebook API access token obtained through Facebook App configuration

Access tokens are generated through Facebook for Developers and provide access to send messages through Facebook Pages and Messenger conversations based on the app permissions and page access granted.


## Helpful Links

- [Facebook for Developers](https://developers.facebook.com/)
- [OpenFn Facebook Adaptor Configuration](https://docs.openfn.org/adaptors/packages/facebook-configuration-schema)
- [OpenFn Facebook Adaptor Docs](https://docs.openfn.org/adaptors/packages/facebook-docs)

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
6 changes: 6 additions & 0 deletions adaptors/fhir-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -719,3 +719,9 @@ b.patient({
identifier: $.patient.
});
```

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
8 changes: 7 additions & 1 deletion adaptors/fhir-fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,10 @@ See the generic [fhir adaptor](/adaptors/fhir) and our [docs on standards](/docu
## Build your own FHIR Adaptor
See the [Adaptors Wiki](https://github.com/OpenFn/adaptors/wiki/Generating-Fhir-Adaptors) to build your own adaptor for _your_ implementation guide by trying out our fhir-adaptor-generator (which is a new tool still in testing).

Please share any questions or feedback on [community.openfn.org](https://community.openfn.org).
Please share any questions or feedback on [community.openfn.org](https://community.openfn.org).

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
8 changes: 7 additions & 1 deletion adaptors/fhir-ndr-et.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,10 @@ See the generic [fhir adaptor](/adaptors/fhir) and our [docs on standards](/docu
## Build your own FHIR Adaptor
See the [Adaptors Wiki](https://github.com/OpenFn/adaptors/wiki/Generating-Fhir-Adaptors) to build your own adaptor for _your_ implementation guide by trying out our fhir-adaptor-generator (which is a new tool still in testing).

Please share any questions or feedback on [community.openfn.org](https://community.openfn.org).
Please share any questions or feedback on [community.openfn.org](https://community.openfn.org).

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
5 changes: 5 additions & 0 deletions adaptors/fhir.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag

Have resources or links to share? Submit a PR to edit this page or post on [community.openfn.org](https://community.openfn.org).

### 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](https://github.com/OpenFn/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](https://community.openfn.org/).
Loading
Loading