From b33dd4e664dca198ac4567d3e94afb635e4702da Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Thu, 23 Jan 2025 09:29:55 +0000 Subject: [PATCH 01/24] Create gmail.md --- adaptors/gmail.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 adaptors/gmail.md diff --git a/adaptors/gmail.md b/adaptors/gmail.md new file mode 100644 index 000000000000..8dcc02dc50cf --- /dev/null +++ b/adaptors/gmail.md @@ -0,0 +1,40 @@ +--- +title: Gmail Adaptor +--- + +## About Gmail + +Gmail is a free email service developed by Google that supports email communication, collaboration, file sharing and integration with other Google services. + +## Integration Options + +Gmail supports 2 primary integration options with OpenFn: + +1. Rest API: Gmail has a REST API that enables external services like OpenFn to pull data from Gmail, or push data from external apps to Gmail. This option is suited for scheduled, bulk syncs or workflows that must update data in Gmail with external information. See [functions](/adaptors/packages/gmail-docs) for more on how to use this adaptor to work with the API. + +2. Webhook: While Gmail does not natively support webhooks, you can implement webhook-like functionality to push data from Gmail to external systems. This option is suited for real-time, event-based data integration. Check out the Gmail [developer documentation](https://developers.google.com/gmail/api/guides/push) to learn how to set up push notifications on Gmail. + +## Authentication + +1. See [Gmail docs](https://developers.google.com/gmail/api/auth/scopes) for the latest on supported authentication methods. +2. When integrating with Gmail via OpenFn, there is one primary authentication method that is supported: **Access Token**. You can generate an access token from Gmail using these [instructions](https://developers.google.com/identity/protocols/oauth2). +3. See this adaptor's [Configuration docs](/adaptors/packages/gmail-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-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: + +``` +{ + "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IjlGWERwYmhax0rZNRlQyU3ZRdVhoODQ2WVR3RUlCdyIsI" +} +``` + +### Helpful Links + +1. [API documentation](https://developers.google.com/gmail/api/guides) + +### Implementation Examples + +_Coming soon!_ + + + From 1d37a34cac20548458b4c8e68f5cef4888173549 Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Thu, 23 Jan 2025 09:31:36 +0000 Subject: [PATCH 02/24] Update asana.md --- adaptors/asana.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/adaptors/asana.md b/adaptors/asana.md index dbc846a2176a..a888dc4a6b19 100644 --- a/adaptors/asana.md +++ b/adaptors/asana.md @@ -10,15 +10,15 @@ title: Asana Adaptor Asana supports 2 primary integration options: -1. Rest API: Asana has an available REST API that enable external services like OpenFn to pull data from Asana, or push data from external apps to Asana. This option is suited for scheduled, bulk syncs or workflows that must update data in Asana with external information. See [functions](/adaptors/packages/asana-docs) for more on how to use this adaptor to work with the API. +1. Rest API: Asana has an available REST API that enables external services like OpenFn to pull data from Asana, or push data from external apps to Asana. This option is suited for scheduled, bulk syncs or workflows that must update data in Asana with external information. See [functions](/adaptors/packages/asana-docs) for more on how to use this adaptor to work with the API. -2. Webhook: Asana also has a [Webhook or Data Forwarding](https://developers.asana.com/docs/webhooks-guide) to push data from Asana to external systems. This option is suited for real-time, event-based data integration. Check out the Asana [devloper documentation](/adaptors/packages/asana-docs) to learn how to set up a webhook to push data to OpenFn. +2. Webhook: Asana also has a [Webhook or Data Forwarding](https://developers.asana.com/docs/webhooks-guide) to push data from Asana to external systems. This option is suited for real-time, event-based data integration. Check out the Asana [developer documentation](/adaptors/packages/asana-docs) to learn how to set up a webhook to push data to OpenFn. ## Authentication See [Asana docs](https://developers.asana.com/docs/authentication) for the latest on supported authentication methods. -When integrating with Asana via OpenFn, there is one primary authentication method supported: **Personal Access Token (PAT)**. You can generate a personal access token from the Asana [developer console](https://developers.asana.com/docs/personal-access-token). +When integrating with Asana via OpenFn, there is one primary authentication method that is supported: **Personal Access Token (PAT)**. You can generate a personal access token from the Asana [developer console](https://developers.asana.com/docs/personal-access-token). See this adaptor's [Configuration docs](/adaptors/packages/asana-configuration-schema) for more on the required authentication parameters. From 52a19edbc0a83bcac1e014e0498ea3592fc258ac Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Thu, 23 Jan 2025 09:54:22 +0000 Subject: [PATCH 03/24] Create googlehealthcare.md --- adaptors/googlehealthcare.md | 42 ++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 adaptors/googlehealthcare.md diff --git a/adaptors/googlehealthcare.md b/adaptors/googlehealthcare.md new file mode 100644 index 000000000000..26d6f9852106 --- /dev/null +++ b/adaptors/googlehealthcare.md @@ -0,0 +1,42 @@ +--- +title: Google Cloud Healthcare Adaptor +--- + +## About Google Cloud Healthcare + +The [Google Cloud Healthcare API](https://cloud.google.com/healthcare-api) is a solution that enables the secure storage, management, and exchange of healthcare data on Google Cloud. It bridges existing care systems and applications hosted on Google Cloud, facilitating interoperability and integration with advanced analytics and machine learning tools. + +## Integration Options + +**1. Rest API:** Google Cloud Healthcare offers a REST API that enables external applications to interact with its database and perform bulk operations. This option is ideal for applications requiring scheduled or bulk synchronization with Google Cloud Healthcare. The API supports the [HL7® FHIR®](https://www.hl7.org/fhir/overview.html) (Fast Healthcare Interoperability Resources) standard. Refer to the Google Cloud Healthcare REST API [documentation](https://cloud.google.com/healthcare-api) for detailed guidelines on endpoints and payload formats. + +**2. Webhook:** The Google Cloud Healthcare API does not natively support webhooks as part of its core functionality. However, you can implement webhook-like behavior using other Google Cloud services and tools in combination with the Healthcare API. + +## Authentication + +1. See [Google Cloud Healthcare API docs](https://cloud.google.com/healthcare-api/docs/authentication#:~:text=You%20can%20authenticate%20to%20the,CLI%20credentials%20and%20ADC%20credentials.) for the latest on supported authentication methods. +2. When integrating with Google Cloud Healthcare via OpenFn, there is one primary authentication method that is supported: **Access Token**. See this adaptor's [Configuration docs](/adaptors/packages/googlehealthcare-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](documentation/manage-projects/manage-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: + +``` +{ + "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IjlGWERwYmZNRlQyU3ZRdVhoODQ2WVR3RUlCdyIsI" +} +``` + +### Helpful Links + +1. [Google Cloud Healthcare API Documentation](https://cloud.google.com/healthcare-api) +2. [Cloud Healthcare API Documentation](https://cloud.google.com/healthcare-api/docs) +3. [FHIR Standard](https://www.hl7.org/fhir/) +4. [Google Cloud Authentication Overview](https://cloud.google.com/docs/authentication) + +### Implementation Examples + +_Coming soon!_ + + + + + From 5a6ed68d2c24f52dfc170978a79cdaa358803a26 Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Thu, 23 Jan 2025 09:56:16 +0000 Subject: [PATCH 04/24] Update googlehealthcare.md --- adaptors/googlehealthcare.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adaptors/googlehealthcare.md b/adaptors/googlehealthcare.md index 26d6f9852106..a2cde303844c 100644 --- a/adaptors/googlehealthcare.md +++ b/adaptors/googlehealthcare.md @@ -8,7 +8,7 @@ The [Google Cloud Healthcare API](https://cloud.google.com/healthcare-api) is a ## Integration Options -**1. Rest API:** Google Cloud Healthcare offers a REST API that enables external applications to interact with its database and perform bulk operations. This option is ideal for applications requiring scheduled or bulk synchronization with Google Cloud Healthcare. The API supports the [HL7® FHIR®](https://www.hl7.org/fhir/overview.html) (Fast Healthcare Interoperability Resources) standard. Refer to the Google Cloud Healthcare REST API [documentation](https://cloud.google.com/healthcare-api) for detailed guidelines on endpoints and payload formats. +**1. Rest API:** Google Cloud Healthcare offers a REST API that enables external applications to interact with its database and perform bulk operations. This option is ideal for applications requiring scheduled or bulk synchronization with Google Cloud Healthcare. The API supports the [HL7® FHIR®](https://www.hl7.org/fhir/overview.html) (Fast Healthcare Interoperability Resources) standard. See [functions](/adaptors/packages/googlehealthcare-docs) for more on how to use this adaptor to work with the API. **2. Webhook:** The Google Cloud Healthcare API does not natively support webhooks as part of its core functionality. However, you can implement webhook-like behavior using other Google Cloud services and tools in combination with the Healthcare API. From 7d547a9eec437924c4e794fad89b42877ab8e4ad Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Thu, 23 Jan 2025 10:06:25 +0000 Subject: [PATCH 05/24] Update gmail.md --- adaptors/gmail.md | 1 + 1 file changed, 1 insertion(+) diff --git a/adaptors/gmail.md b/adaptors/gmail.md index 8dcc02dc50cf..185d900ae5d6 100644 --- a/adaptors/gmail.md +++ b/adaptors/gmail.md @@ -31,6 +31,7 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag ### Helpful Links 1. [API documentation](https://developers.google.com/gmail/api/guides) +2. [Community Support](https://support.google.com/mail/) ### Implementation Examples From 7ea3ff3a6d5ee7c4a80df298954fd3104b87032e Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Thu, 23 Jan 2025 10:09:41 +0000 Subject: [PATCH 06/24] Create mailgun.md --- adaptors/mailgun.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 adaptors/mailgun.md diff --git a/adaptors/mailgun.md b/adaptors/mailgun.md new file mode 100644 index 000000000000..e16f6bb1cd72 --- /dev/null +++ b/adaptors/mailgun.md @@ -0,0 +1,42 @@ +--- +title: Mailgun Adaptor +--- + +## About Mailgun + +Mailgun is an email delivery service designed for developers and provides APIs for sending, receiving, and tracking emails. + +## Integration Options + +Mailgun supports 2 primary integration options with OpenFn: + +1. **Rest API:** Mailgun has a REST API that enables external services like OpenFn to pull data from Mailgun, or push data from external apps to Mailgun. This option is suited for scheduled, bulk syncs or workflows that must update data in Mailgun with external information. See [functions](/adaptors/packages/mailgun-docs) for more on how to use this adaptor to work with the API. + +2. **Webhook:** Webhook or Data Forwarding to push data from Mailgun to external systems (see [docs](https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/#webhooks)). This option is suited for real-time, event-based data integration. + +## Authentication + +1. See [Mailgun docs](https://developers.google.com/gmail/api/auth/scopes) for the latest on supported authentication methods. +2. When integrating with Mailgun via OpenFn, there is one primary authentication method that is supported: **API Key**. See this adaptor's [Configuration docs](/adaptors/packages/mailgun-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-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: + +``` +{ + "domain": "sandbox-123.mailgun.org", + "apiKey": "otherThiNGfSECret" +} +``` + +### Helpful Links + +1. [Mailgun API Documentation](https://documentation.mailgun.com/) +2. [Event Webhooks](https://documentation.mailgun.com/en/latest/api-events.html#event-webhooks) +3. [Support and Community](https://help.mailgun.com/) + +### Implementation Examples + +1. [Women for Women International - Committed Giving <> Salesforce Integration](https://github.com/OpenFn/women-for-women?tab=readme-ov-file#email-alerts) + + + From ac8f942a0177615a0515d98b4c700c8d6c26be59 Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Thu, 23 Jan 2025 11:03:26 +0000 Subject: [PATCH 07/24] Update mailgun.md --- adaptors/mailgun.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adaptors/mailgun.md b/adaptors/mailgun.md index e16f6bb1cd72..d1957346b329 100644 --- a/adaptors/mailgun.md +++ b/adaptors/mailgun.md @@ -4,7 +4,7 @@ title: Mailgun Adaptor ## About Mailgun -Mailgun is an email delivery service designed for developers and provides APIs for sending, receiving, and tracking emails. +[Mailgun](https://www.mailgun.com/) is an email delivery service designed for developers and provides APIs for sending, receiving, and tracking emails. ## Integration Options From cc2e3983cfe64191b162c2b5ac676082996d4181 Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Thu, 23 Jan 2025 11:15:41 +0000 Subject: [PATCH 08/24] Create telerivet.md --- adaptors/telerivet.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 adaptors/telerivet.md diff --git a/adaptors/telerivet.md b/adaptors/telerivet.md new file mode 100644 index 000000000000..809db1da86ec --- /dev/null +++ b/adaptors/telerivet.md @@ -0,0 +1,43 @@ +--- +title: Telerivet Adaptor +--- + +## About Telerivet + +[Telerivet](https://www.telerivet.com/) is a platform for sending, receiving, and automating SMS, voice calls, and mobile messaging through various channels. Telerivet is commonly used for customer notifications, marketing campaigns, and transactional messaging. + +## Integration Options + +Telerivet supports 2 primary integration options with OpenFn: + +1. **Rest API:** Telerivet has a REST API that enables external services like OpenFn to pull data from Telerivet, or push data from external apps to Telerivet. This option is suited for scheduled, bulk syncs or workflows that must update data in Telerivet with external information. See [functions](/adaptors/packages/telerivet-docs) for more on how to use this adaptor to work with the API. + +2. **Webhook:** Webhook or Data Forwarding to push data from Telerivet to external systems (see [docs](https://telerivet.com/api/webhook)). This option is suited for real-time, event-based data integration. + +## Authentication + +1. See [Telerivet docs](https://developers.google.com/gmail/api/auth/scopes) for the latest on supported authentication methods. +2. When integrating with Telerivet via OpenFn, there is one primary authentication method that is supported: **API Key**. See this adaptor's [Configuration docs](/adaptors/packages/telerivet-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-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: + +``` +{ + "projectId": "telerivet_project_id", + "apiKey": "telerivet_api_key" +} +``` + +### Helpful Links + +1. [Telerivet API Documentation](https://telerivet.com/api) +2. [Webhook Setup](https://telerivet.com/help/webhooks) + + + +### Implementation Examples + +_Coming soon!_ + + + From 09198d8653a716eb9707aeed5a87d7a6f9f892f5 Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Mon, 27 Jan 2025 16:11:31 +0000 Subject: [PATCH 09/24] Create twilio.md --- adaptors/twilio.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 adaptors/twilio.md diff --git a/adaptors/twilio.md b/adaptors/twilio.md new file mode 100644 index 000000000000..1246ca391529 --- /dev/null +++ b/adaptors/twilio.md @@ -0,0 +1,41 @@ +--- +title: Twilio Adaptor +--- + +## About Twilio + +[Twilio](https://www.twilio.com/en-us) is a cloud communications platform that enables developers to build and scale applications for voice, messaging, video, and other communication channels. + +## Integration Options + +Twilio supports 2 primary integration options with OpenFn: + +1. **Rest API:** Twilio has a REST API that enables external services like OpenFn to pull data from Twilio, or push data from external apps to Twilio. This option is suited for scheduled, bulk syncs or workflows that must update data in Twilio with external information. See [functions](/adaptors/packages/twilio-docs) for more on how to use this adaptor to work with the API. +2. **Webhook:** Webhook or Data Forwarding to push data from Twilio to external systems (see [docs](https://www.twilio.com/docs/usage/webhooks)). This option is suited for real-time, event-based data integration. + +## Authentication + +1. See [Twilio docs](https://www.twilio.com/docs/) for the latest on supported authentication methods. +2. When integrating with Twilio via OpenFn, there is one primary authentication method that is supported: **API Key**. See this adaptor's [Configuration docs](/adaptors/packages/twilio-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-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: + +``` +{ + "accountSid": "account_id", + "authToken": "evenMoreSecret" +} +``` + +### Helpful Links + +1. [Twilio API Documentation](https://www.twilio.com/docs/) +2. [Webhook Setup](https://www.twilio.com/docs/usage/webhooks) + + +### Implementation Examples + +_Coming soon!_ + + + From 1b30bbaacc0b7b6970561c0f9dfe6115c46bff3e Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Mon, 27 Jan 2025 16:26:59 +0000 Subject: [PATCH 10/24] Create redis.md --- adaptors/redis.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 adaptors/redis.md diff --git a/adaptors/redis.md b/adaptors/redis.md new file mode 100644 index 000000000000..73689037253b --- /dev/null +++ b/adaptors/redis.md @@ -0,0 +1,37 @@ +--- +title: Redis Adaptor +--- + +## About Redis + +[Redis (Remote Dictionary Server)](https://redis.io/) is an open-source, in-memory data store used as a database, cache, and message broker. It is commonly used for caching, real-time analytics, session management, and pub/sub messaging. + + +## Integration Options + +The `redis` adaptor provides direct database connections for accessing data and executing NoSQL and standard database operations. See [functions](/adaptors/packages/redis-docs) for more on how to use this adaptor. + + +## Authentication + +See [Redis](https://redis.io/docs/latest/) for the latest on supported authentication methods. When integrating with a NoSQL database via OpenFn, you authenticate via SSH using authorized database credentials. See this adaptor's [Configuration docs](/adaptors/packages/redis-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-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": "redis.example.com", + "password": "@some(!)Str0ngp4ss0w0rd", + "username": "test@openfn.org" +} +``` + +### Helpful Links + +1. [Redis Documentation](https://redis.io/documentation) + + + + + + From 033f1d901f32c0259d21bbe122d37335c196c656 Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Tue, 28 Jan 2025 00:48:00 +0000 Subject: [PATCH 11/24] Create hive.md --- adaptors/hive.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 adaptors/hive.md diff --git a/adaptors/hive.md b/adaptors/hive.md new file mode 100644 index 000000000000..4b4bc2548a59 --- /dev/null +++ b/adaptors/hive.md @@ -0,0 +1,37 @@ +--- +title: Hive Adaptor +--- + +## About Apache Hive + +[Apache Hive](https://hive.apache.org/) is a data warehouse software that facilitates reading, writing, and managing large datasets stored in distributed storage systems. + +## Integration Options + +The `hive` adaptor provides direct database connections for accessing data and executing SQL and standard database operations. See [functions](/adaptors/packages/hive-docs) for more on how to use this adaptor. + + +## Authentication + +See [Hive docs](https://hive.apache.org/docs/) for the latest on supported authentication methods. When integrating with a Hive database via OpenFn, you authenticate via SSH using authorized database credentials. See this adaptor's [Configuration docs](/adaptors/packages/hive-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-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": "some-host-url.compute-1.amazonaws.com", + "database": "demo-db", + "username": "admin-demo", + "password": "@super(!)Secretpass" +} +``` + +### Helpful Links + +1. [Hive documentation](https://hive.apache.org/) + + + + + + From fde643916526268c481d95c0dd821d010582f794 Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Tue, 28 Jan 2025 13:19:19 +0000 Subject: [PATCH 12/24] Update hive.md --- adaptors/hive.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/adaptors/hive.md b/adaptors/hive.md index 4b4bc2548a59..6e1f122999f4 100644 --- a/adaptors/hive.md +++ b/adaptors/hive.md @@ -31,6 +31,9 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag 1. [Hive documentation](https://hive.apache.org/) +### Implementation Examples + +_Comming soon!_ From 88fe7eb47d87024841d65c014d773c3402643123 Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Tue, 28 Jan 2025 13:40:06 +0000 Subject: [PATCH 13/24] Create dynamics.md --- adaptors/dynamics.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 adaptors/dynamics.md diff --git a/adaptors/dynamics.md b/adaptors/dynamics.md new file mode 100644 index 000000000000..22489f43501b --- /dev/null +++ b/adaptors/dynamics.md @@ -0,0 +1,41 @@ +--- +title: Dynamics Adaptor +--- + +## About Microsoft Dynamics + +[Microsoft Dynamics](https://www.microsoft.com/en-us/dynamics-365) is a suite of enterprise resource planning (ERP) and customer relationship management (CRM) applications. It helps organizations manage sales, customer service, marketing, operations, and more. + +## Integration Options + +**1. Rest API:** Dynamics offers a REST API that enables external applications to interact with its database and perform bulk operations. This option is ideal for applications requiring scheduled or bulk synchronization with Dynamics. Refer to the Dynamics REST API [documentation](https://learn.microsoft.com/en-us/powerapps/developer/data-platform/webapi/overview) for detailed guidelines on endpoints and payload formats. + +**2. Webhook:** Webhook or Data Forwarding to push data from Dynamics to external systems (see [docs](https://learn.microsoft.com/en-us/dynamics365/customer-engagement/developer/webhooks)). This option is suited for real-time, event-based data integration. + +## Authentication + +See [Microsoft docs](https://learn.microsoft.com/en-us/azure/active-directory/) for the latest on supported authentication methods. When integrating with Dynamics via OpenFn, **Access Token** is supported. See this adaptor's [Configuration docs](/adaptors/packages/dynamics-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](documentation/manage-projects/manage-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: + +``` +{ + "resource": "https://openfn.crm2.dynamics.com", + "apiVersion": "8.2.0", + "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IjlGWERwYmZNRlQyU3ZRdVhoODQ2WVR3RUlCdyIsI" +} +``` + +### Helpful Links + +1. [Microsoft Dynamics Documentation](https://learn.microsoft.com/en-us/dynamics365/) +2. [Dynamics REST API Guide](https://learn.microsoft.com/en-us/powerapps/developer/data-platform/webapi/overview) +3. [Webhooks Setup](https://learn.microsoft.com/en-us/dynamics365/customer-engagement/developer/webhooks) + +### Implementation Examples + +_Comming soon!_ + + + + From 9d59deead16fdca26c3c25147bd60c22bc891911 Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Tue, 28 Jan 2025 14:09:42 +0000 Subject: [PATCH 14/24] Update hive.md --- adaptors/hive.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adaptors/hive.md b/adaptors/hive.md index 6e1f122999f4..8f7f82827dfc 100644 --- a/adaptors/hive.md +++ b/adaptors/hive.md @@ -33,7 +33,7 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag ### Implementation Examples -_Comming soon!_ +_Coming soon!_ From 4767716a202a8e8693424f9fd183525f9a5fbe39 Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Tue, 28 Jan 2025 14:10:28 +0000 Subject: [PATCH 15/24] Update redis.md --- adaptors/redis.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/adaptors/redis.md b/adaptors/redis.md index 73689037253b..7f403cb205d2 100644 --- a/adaptors/redis.md +++ b/adaptors/redis.md @@ -31,7 +31,8 @@ See platform docs on [managing credentials](/documentation/manage-projects/manag 1. [Redis Documentation](https://redis.io/documentation) +### Implementation Examples - +_Coming soon!_ From ee80886da9056ce385308883713965afb89d748f Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Tue, 28 Jan 2025 14:13:06 +0000 Subject: [PATCH 16/24] Create openlmis.md --- adaptors/openlmis.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 adaptors/openlmis.md diff --git a/adaptors/openlmis.md b/adaptors/openlmis.md new file mode 100644 index 000000000000..aae2d9815312 --- /dev/null +++ b/adaptors/openlmis.md @@ -0,0 +1,43 @@ +--- +title: OpenLMIS Adaptor +--- + +## About OpenLMIS + +[OpenLMIS (Open Logistics Management Information System)](https://openlmis.org/) is an open-source, electronic logistics management information system designed to improve the management and distribution of health commodities. It enables supply chain management, providing visibility and accuracy in inventory tracking, order management, and reporting. + + +## Integration Options + +OpenLMIS supports 2 primary integration options with OpenFn: + +1. **Rest API:** OpenLMIS has a REST API that enables external services like OpenFn to pull data from OpenLMIS, or push data from external apps to OpenLMIS. This option is suited for scheduled, bulk syncs or workflows that must update data in OpenLMIS with external information. See [functions](/adaptors/packages/openlmis-docs) for more on how to use this adaptor to work with the API. + +2. **Webhook:** Webhook or Data Forwarding to push data from OpenLMIS to external systems (see [docs](https://openlmis.org/documentation/)). This option is suited for real-time, event-based data integration. + +## Authentication + +1. See [OpeLMIS docs](https://openlmis.github.io/openlmis-api/) for the latest on supported authentication methods. +2. When integrating with OpenLMIS via OpenFn, there is one primary authentication method that is supported: **Basic Authentication**. See this adaptor's [Configuration docs](/adaptors/packages/openlmis-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-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: + +``` +{ + "password": "@some(!)Str0ngp4ss0w0rd", + "username": "administrator", + "baseUrl": "https://test.openlmis.org" +} +``` + +### Helpful Links + +1. [OpenLMIS Documentation](https://openlmis.org/documentation/) +2. [OpenLMIS API Guide](https://openlmis.github.io/openlmis-api/) +3. [Integration Guide](https://openlmis.org/integration/) + +### Implementation Examples + +_Coming soon!_ + + From c6875e4bdf30e2d19c44c8e7ed50a2dd0459727c Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Tue, 28 Jan 2025 14:34:15 +0000 Subject: [PATCH 17/24] Create openspp.md --- adaptors/openspp.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 adaptors/openspp.md diff --git a/adaptors/openspp.md b/adaptors/openspp.md new file mode 100644 index 000000000000..7c31f6530edd --- /dev/null +++ b/adaptors/openspp.md @@ -0,0 +1,45 @@ +--- +title: OpenSSP Adaptor +--- + +## About OpenSSP + +[OpenSPP (Open Smart Patient Platform)](https://openspp.org/) is an open-source platform designed to support patient-centric workflows in healthcare delivery. It enables healthcare providers to manage patient data, schedule appointments, track health outcomes, and improve service delivery through real-time data insights and integration capabilities. + +## Integration Options + +OpenSPP supports 2 primary integration options with OpenFn: + +1. **Rest API:** OpenSPP has a REST API that enables external services like OpenFn to pull data from OpenSPP, or push data from external apps to OpenSPP. This option is suited for scheduled, bulk syncs or workflows that must update data in OpenSPP with external information. See [functions](/adaptors/packages/openspp-docs) for more on how to use this adaptor to work with the API. + +2. **Webhook:** Webhook or Data Forwarding to push data from OpenSPP to external systems (see [docs](https://openspp.org/api)). This option is suited for real-time, event-based data integration. + +## Authentication + +1. See [OpenSPP docs](https://openspp.org/security) for the latest on supported authentication methods. +2. When integrating with OpenSPP via OpenFn, there is one primary authentication method that is supported: **Basic Authentication**. See this adaptor's [Configuration docs](/adaptors/packages/openspp-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-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: + +``` +{ + "password": "@some(!)Str0ngp4ss0w0rd", + "username": "test@openfn.org", + "database": "devel", + "baseUrl": "https://dev.newlogic-demo.com" +} +``` + +### Helpful Links + +1. [OpenSPP Documentation](https://openspp.org/documentation) +2. [API Reference](https://openspp.org/api) +3. [Integration Guide](https://openspp.org/integration) + +### Implementation Examples + +_Coming soon!_ + + + + From 51eeaf5e0a69c7d8a02b64f9151f80b0a2873a26 Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Tue, 28 Jan 2025 14:39:07 +0000 Subject: [PATCH 18/24] Update openlmis.md --- adaptors/openlmis.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adaptors/openlmis.md b/adaptors/openlmis.md index aae2d9815312..588fb77a5e5b 100644 --- a/adaptors/openlmis.md +++ b/adaptors/openlmis.md @@ -17,7 +17,7 @@ OpenLMIS supports 2 primary integration options with OpenFn: ## Authentication -1. See [OpeLMIS docs](https://openlmis.github.io/openlmis-api/) for the latest on supported authentication methods. +1. See [OpenLMIS docs](https://openlmis.github.io/openlmis-api/) for the latest on supported authentication methods. 2. When integrating with OpenLMIS via OpenFn, there is one primary authentication method that is supported: **Basic Authentication**. See this adaptor's [Configuration docs](/adaptors/packages/openlmis-configuration-schema) for more on the required authentication parameters. See platform docs on [managing credentials](/documentation/manage-projects/manage-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: From b9886447fc908e12f8cd36b24fa45701a3becaec Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Tue, 28 Jan 2025 15:10:17 +0000 Subject: [PATCH 19/24] Create openimis.md --- adaptors/openimis.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 adaptors/openimis.md diff --git a/adaptors/openimis.md b/adaptors/openimis.md new file mode 100644 index 000000000000..39ab05e6131a --- /dev/null +++ b/adaptors/openimis.md @@ -0,0 +1,43 @@ +--- +title: OpenIMIS Adaptor +--- + +## About OpenIMIS + +[OpenIMIS (Open Insurance Management Information System)](https://openimis.org/) is an open-source software solution designed to manage health financing schemes such as health insurance, results-based financing, and universal health coverage. + +## Integration Options + +OpenIMIS supports 2 primary integration options with OpenFn: + +1. **Rest API:** OpenIMIS has a REST API that enables external services like OpenFn to pull data from OpenIMIS, or push data from external apps to OpenIMIS. This option is suited for scheduled, bulk syncs or workflows that must update data in OpenIMIS with external information. See [functions](/adaptors/packages/openimis-docs) for more on how to use this adaptor to work with the API. + +2. **Webhook:** OpenIMIS does not natively support webhooks as a standard feature. However, integrations and custom implementations can enable webhook-like behavior. More details can be found on the OpenMRS [documentation page​](https://wiki.openmrs.org/). + +## Authentication + +1. See [OpenIMIS docs](https://docs.openimis.org/en/latest/user_manual/user_login/login.html) for the latest on supported authentication methods. +2. When integrating with OpenIMIS via OpenFn, there is one primary authentication method that is supported: **Basic Authentication**. See this adaptor's [Configuration docs](/adaptors/packages/openimis-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-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: + +``` +{ + "baseUrl": "https://demo.openimis.org", + "username": "test@openfn.org", + "password": "@some(!)Str0ngp4ss0w0rd" +} +``` + +### Helpful Links + +1. [OpenIMIS Documentation](https://openimis.org/documentation) +2. [API Reference (REST & GraphQL)](https://openimis.org/api) +3. [Integration Guide](https://openimis.org/integration) + + +### Implementation Examples + +_Coming soon!_ + + From 65c0fd5022bccb918c78f03d60629eaa78a3893a Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Tue, 28 Jan 2025 15:26:04 +0000 Subject: [PATCH 20/24] Create openhim.md --- adaptors/openhim.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 adaptors/openhim.md diff --git a/adaptors/openhim.md b/adaptors/openhim.md new file mode 100644 index 000000000000..2021091a4dc5 --- /dev/null +++ b/adaptors/openhim.md @@ -0,0 +1,41 @@ +--- +title: OpenHIM Adaptor +--- + +## About OpenHIM + +[OpenHIM (Open Health Information Mediator)](https://openhim.org/) is an open-source, middleware solution designed to facilitate interoperability between health information systems. It acts as a mediator, handling data transformation, validation, and routing between various systems. + +## Integration Options + +OpenHIM supports 2 primary integration options with OpenFn: + +1. **Rest API:** OpenHIM has a REST API that enables external services like OpenFn to pull data from OpenHIM, or push data from external apps to OpenHIM. This option is suited for scheduled, bulk syncs or workflows that must update data in OpenHIM with external information. See [functions](/adaptors/packages/openhim-docs) for more on how to use this adaptor to work with the API. + +2. **Webhook:** Webhook or Data Forwarding to push data from OpenHIM to external systems (see [docs](https://openhim.org/docs/user-guide/alerting-reports/)). This option is suited for real-time, event-based data integration. + +## Authentication + +1. See [OpenHIM docs](https://openhim.org/documentation) for the latest on supported authentication methods. +2. When integrating with OpenHIM via OpenFn, there is one primary authentication method that is supported: **Basic Authentication**. See this adaptor's [Configuration docs](/adaptors/packages/openhim-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-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: + +``` +{ + "apiUrl": "http://openhim.com/api" +} +``` + +### Helpful Links + +1. [OpenHIM Documentation](https://openhim.org/documentation) +2. [OpenHIM API Reference](https://openhim.org/api) + +### Implementation Examples + +_Coming soon!_ + + + + From 56ac4a8c7c226acf4349affbcbd644058f283953 Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Tue, 28 Jan 2025 15:38:30 +0000 Subject: [PATCH 21/24] Create azure-storage.md --- adaptors/azure-storage.md | 40 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 adaptors/azure-storage.md diff --git a/adaptors/azure-storage.md b/adaptors/azure-storage.md new file mode 100644 index 000000000000..276177010547 --- /dev/null +++ b/adaptors/azure-storage.md @@ -0,0 +1,40 @@ +--- +title: Azure Storage +--- + +## About Azure Storage + +[Azure Storage](https://azure.microsoft.com/en-us/products/category/storage) is a cloud-based storage solution provided by Microsoft Azure. It offers scalable and secure storage options for a wide range of data, including unstructured, semi-structured, and structured data. +## Integration Options + +Azure Storage supports 2 primary integration options with OpenFn: + +1. **Rest API:** Azure Storage has a REST API that enables external services like OpenFn to pull data from Azure Storage, or push data from external apps to Azure Storage. This option is suited for scheduled, bulk syncs or workflows that must update data in Azure Storage with external information. See [functions](/adaptors/packages/azure-storage-docs) for more on how to use this adaptor to work with the API. +2. **Webhook:** Webhook or Data Forwarding to push data from Azure Storage to external systems (see [docs](https://learn.microsoft.com/en-us/azure/storage/)). This option is suited for real-time, event-based data integration. + +## Authentication + +1. See [Azure Storage docs](https://learn.microsoft.com/en-us/azure/storage/) for the latest on supported authentication methods. +2. When integrating with Azure Storage via OpenFn, there is one primary authentication method that is supported: **API Key**. See this adaptor's [Configuration docs](/adaptors/packages/azure-stroage-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-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: + +``` +{ + "accountName": "examplestorageaccount01", + "accountKey": "zzUx5rA4BZkjPet8ztLTEll7azF65Sez7WxGKsJv5B+rp/dby8ARgYpEVe93xFCQDqGBi3FUlxjP+ASt4uepZg==" +} +``` + +### Helpful Links + +1. [Azure Storage Documentation](https://learn.microsoft.com/en-us/azure/storage/) +2. [Azure Blob Storage REST API](https://learn.microsoft.com/en-us/rest/api/storageservices/) + +### Implementation Examples + +_Coming soon!_ + + + + From 136f894d207a430ae94f3172ad1f95671b74535c Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Wed, 29 Jan 2025 02:21:43 +0000 Subject: [PATCH 22/24] Update azure-storage.md --- adaptors/azure-storage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adaptors/azure-storage.md b/adaptors/azure-storage.md index 276177010547..432aa0b17823 100644 --- a/adaptors/azure-storage.md +++ b/adaptors/azure-storage.md @@ -15,7 +15,7 @@ Azure Storage supports 2 primary integration options with OpenFn: ## Authentication 1. See [Azure Storage docs](https://learn.microsoft.com/en-us/azure/storage/) for the latest on supported authentication methods. -2. When integrating with Azure Storage via OpenFn, there is one primary authentication method that is supported: **API Key**. See this adaptor's [Configuration docs](/adaptors/packages/azure-stroage-configuration-schema) for more on the required authentication parameters. +2. When integrating with Azure Storage via OpenFn, there is one primary authentication method that is supported: **API Key**. See this adaptor's [Configuration docs](/adaptors/packages/azure-storage-configuration-schema) for more on the required authentication parameters. See platform docs on [managing credentials](/documentation/manage-projects/manage-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: From 463abd9fcdad784536b90b9768c1ad750e7d104f Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Wed, 29 Jan 2025 02:27:38 +0000 Subject: [PATCH 23/24] Create bigquery.md --- adaptors/bigquery.md | 50 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 adaptors/bigquery.md diff --git a/adaptors/bigquery.md b/adaptors/bigquery.md new file mode 100644 index 000000000000..7c4a05846eb7 --- /dev/null +++ b/adaptors/bigquery.md @@ -0,0 +1,50 @@ +--- +title: Big Query +--- + +## About Big Query + +BigQuery is Google Cloud’s fully managed, serverless, and highly scalable data warehouse solution. It enables organizations to store, analyze, and visualize large datasets using SQL queries, machine learning, and real-time analytics. + +## Integration Options + +BigQuery supports 2 primary integration options with OpenFn: + +1. **Rest API:** BigQuery has a REST API that enables external services like OpenFn to pull data from BigQuery, or push data from external apps to BigQuery. This option is suited for scheduled, bulk syncs or workflows that must update data in BigQuery with external information. See [functions](/adaptors/packages/bigquery-docs) for more on how to use this adaptor to work with the API. +2. **Webhook:** Webhook or Data Forwarding to push data from BigQuery to external systems (see [docs](https://cloud.google.com/run/docs/triggering/webhooks)). This option is suited for real-time, event-based data integration. + +## Authentication + +1. See [BigQuery docs](https://cloud.google.com/bigquery/docs) for the latest on supported authentication methods. +2. When integrating with BigQuery via OpenFn, there is one primary authentication method that is supported: **API Key**. See this adaptor's [Configuration docs](/adaptors/packages/bigquery-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-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: + +``` +{ + "type": "service_acconut", + "project_id": "some-project-id", + "private_key_id": "670b9e3c8c366e83aa569dd57cbfc5c575b72e42", + "private_key": "-----BEGIN PRIVATE KEY-----\nblah\nmoreblah=\n-----END PRIVATE KEY-----\n", + "client_email": "bigquery@some-project.iam.gserviceaccount.com", + "client_id": "someid", + "auth_uri": "https://accounts.google.com/o/oauth2/auth", + "token_uri": "https://oauth2.googleapis.com/token", + "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", + "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/bigquery%40some-project.iam.gserviceaccount.com" +} +``` + +### Helpful Links + +1. [BigQuery Documentation](https://cloud.google.com/bigquery/docs) +2. [BigQuery REST API](https://cloud.google.com/bigquery/docs/reference/rest) + + +### Implementation Examples + +_Coming soon!_ + + + + From 217d7d26b832abc5c7d1b0070fe9ac73ac55797a Mon Sep 17 00:00:00 2001 From: daissatou2 <80456839+daissatou2@users.noreply.github.com> Date: Wed, 29 Jan 2025 15:40:24 +0000 Subject: [PATCH 24/24] Create beyonic.md --- adaptors/beyonic.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 adaptors/beyonic.md diff --git a/adaptors/beyonic.md b/adaptors/beyonic.md new file mode 100644 index 000000000000..f9941164d3e8 --- /dev/null +++ b/adaptors/beyonic.md @@ -0,0 +1,42 @@ +--- +title: Beyonic +--- + +## About Beyonic + +Beyonic is a digital payments platform that supports mobile money payments, collections, and bulk disbursements, offering integration with major mobile network operators and banks. + +## Integration Options + +Beyonic supports 2 primary integration options with OpenFn: + +1. **Rest API:** Beyonic has a REST API that enables external services like OpenFn to pull data from Beyonic, or push data from external apps to Beyonic. This option is suited for scheduled, bulk syncs or workflows that must update data in Beyonic with external information. See [functions](/adaptors/packages/beyonic-docs) for more on how to use this adaptor to work with the API. +2. **Webhook:** Webhook or Data Forwarding to push data from Beyonic to external systems (see [docs](https://apidocs.beyonic.com/webhooks)). This option is suited for real-time, event-based data integration. + +## Authentication + +1. See [Beyonic docs](https://apidocs.beyonic.com) for the latest on supported authentication methods. +2. When integrating with Beyonic via OpenFn, there is one primary authentication method that is supported: **API Key**. See this adaptor's [Configuration docs](/adaptors/packages/beyonic-configuration-schema) for more on the required authentication parameters. + +See platform docs on [managing credentials](/documentation/manage-projects/manage-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: + +``` +{ + "apiUrl": "https://beyonic.com/api", + "apiToken": "cdjhiooiSIUJHDYSYUIHASIOHKAANOAJJjsiujhaka" +} +``` + +### Helpful Links + +1. [Beyonic Documentation](https://apidocs.beyonic.com) +2. [Beyonic API Reference](https://apidocs.beyonic.com/reference) +3. [Webhook Guide](https://apidocs.beyonic.com/webhooks) + +### Implementation Examples + +_Coming soon!_ + + + +