Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
204 commits
Select commit Hold shift + click to select a range
8a43e9b
tweak collections docs to make CLI usage clearer
josephjclark Nov 15, 2024
6707010
collections: docs tweak
josephjclark Nov 15, 2024
5c396e3
Updated roadmap for November
christad92 Nov 27, 2024
1b6b8ff
Changed copy to reflect community updates
christad92 Nov 27, 2024
ae69245
Added q3 features
christad92 Nov 28, 2024
c932daf
minot fix with prettier
christad92 Nov 28, 2024
77a39ab
remove numbers
taylordowns2000 Nov 29, 2024
e21bbb1
Merge pull request #606 from OpenFn/november-roadmap
taylordowns2000 Nov 29, 2024
a62f9d2
Adaptor overview pages (#608)
daissatou2 Nov 29, 2024
ec216a9
updated fhir docs (#609)
aleksa-krolls Dec 1, 2024
f3a8457
Fixed typos and readaility
christad92 Dec 5, 2024
64bdd10
More copy updates
christad92 Dec 5, 2024
7c6f7cb
add collections CLI docs
josephjclark Dec 6, 2024
dff7290
Mailchimp & OCL overview pages (#610)
daissatou2 Dec 7, 2024
35e7aa1
Bump cross-spawn from 7.0.3 to 7.0.6 (#603)
dependabot[bot] Dec 9, 2024
98559e1
Update writing-code.md
PiusKariuki Dec 9, 2024
09c70bb
Merge pull request #615 from PiusKariuki/patch-1
josephjclark Dec 9, 2024
f84395d
collectios: docs improvements
josephjclark Dec 9, 2024
7ffbde9
add generate-library
mtuchi Dec 9, 2024
23466ee
update dhis2 examples
mtuchi Dec 9, 2024
94a27f2
remove fn block
mtuchi Dec 10, 2024
99ca93f
Merge pull request #617 from OpenFn/dhis2-docs
josephjclark Dec 10, 2024
901dc64
Bump nanoid from 3.3.7 to 3.3.8
dependabot[bot] Dec 10, 2024
e4fee1b
add TODOs for documenting
josephjclark Dec 11, 2024
19952a4
extra docs
josephjclark Dec 11, 2024
3d9d5e1
updates
josephjclark Dec 12, 2024
f0c321c
Update cli-collections.md
ritazagoni Dec 12, 2024
74b7b68
Merge pull request #613 from OpenFn/collections-cli
josephjclark Dec 12, 2024
95cf7e8
minor copyedits
ritazagoni Dec 17, 2024
9463996
edit
ritazagoni Dec 23, 2024
335e23f
Merge pull request #620 from OpenFn/collections-edits
josephjclark Dec 24, 2024
b6cc6ba
Merge pull request #618 from OpenFn/dependabot/npm_and_yarn/nanoid-3.3.8
josephjclark Dec 24, 2024
14c62b7
minor adjustments
josephjclark Dec 24, 2024
868f23b
Merge pull request #612 from OpenFn/minor-comments-collections
josephjclark Dec 24, 2024
b05df67
update examples
josephjclark Dec 24, 2024
f8b9aaa
copyedit
ritazagoni Jan 1, 2025
be2b5fd
copyedit
ritazagoni Jan 1, 2025
ba236b5
Merge pull request #619 from OpenFn/collections-tweak
josephjclark Jan 3, 2025
b71dab4
oscar-user
daissatou2 Jan 8, 2025
195fd60
January 2025 Roadmap update
christad92 Jan 10, 2025
baedbb8
update login url information
mtuchi Jan 13, 2025
76cb7b2
update salesforce oauth2 image
mtuchi Jan 13, 2025
a3275e0
Updated roadmap
christad92 Jan 13, 2025
dd84596
updated roadmap
christad92 Jan 13, 2025
ac20a73
more on roadmap
christad92 Jan 13, 2025
4f050d4
Minor changes
christad92 Jan 13, 2025
52f0433
minor change
christad92 Jan 13, 2025
9dbbdfe
Merge branch 'main' into collections-docs-tweak
taylordowns2000 Jan 14, 2025
2b0e88b
Merge pull request #602 from OpenFn/collections-docs-tweak
taylordowns2000 Jan 14, 2025
5fe95af
run formatter
taylordowns2000 Jan 14, 2025
fa7019b
spellcheck
taylordowns2000 Jan 14, 2025
b64e6ec
Merge pull request #624 from OpenFn/jan-25-update
taylordowns2000 Jan 14, 2025
1efa297
update loginUrl instruction
mtuchi Jan 14, 2025
58ce683
Merge pull request #623 from OpenFn/503-sf-docs
josephjclark Jan 14, 2025
0cc4ea7
keystrokes
taylordowns2000 Jan 14, 2025
9a9c579
add sidebar
taylordowns2000 Jan 14, 2025
4acd7d2
add explanation of unique webhook triggers for migration (#621)
ritazagoni Jan 15, 2025
8de273e
Minor fix with the callout
christad92 Jan 15, 2025
1be982b
Merge pull request #625 from OpenFn/keystrokes
taylordowns2000 Jan 15, 2025
47c3bfe
first draft of workflow api docs
josephjclark Jan 17, 2025
bf453e6
update docs after testing
josephjclark Jan 17, 2025
c9586cd
tweaks
josephjclark Jan 17, 2025
a7da98d
add version note
josephjclark Jan 17, 2025
5a0084c
Save and Sync notes to docs.
christad92 Jan 20, 2025
04e294c
Merge pull request #627 from OpenFn/add-save-and-sync
taylordowns2000 Jan 20, 2025
a288a16
copyedit workflows-api.md
ritazagoni Jan 20, 2025
a15056b
Merge pull request #626 from OpenFn/workflow-api-docs
josephjclark Jan 20, 2025
da3ac5b
new roadmap formats
taylordowns2000 Jan 20, 2025
6a7ce36
Merge branch 'main' of github.com:OpenFn/docs
taylordowns2000 Jan 20, 2025
7c8a325
run formatter
taylordowns2000 Jan 20, 2025
4342bf0
image & lang
taylordowns2000 Jan 20, 2025
572f942
Account deletion protocol
christad92 Jan 27, 2025
27023fe
Add notes on disabling workflows and GH sync (#629)
ritazagoni Jan 27, 2025
766c712
update sample url in 'connected apps' documentation
taylordowns2000 Jan 28, 2025
90686c5
run formatter
taylordowns2000 Jan 29, 2025
0fc7749
adjust language
taylordowns2000 Jan 29, 2025
baff60f
Merge pull request #628 from OpenFn/deletion-protocol
taylordowns2000 Jan 29, 2025
4079972
fix collections links
josephjclark Jan 30, 2025
c5841c0
Merge pull request #632 from OpenFn/collections-links
josephjclark Jan 30, 2025
9a7c30a
feat: add examples to kobotoolbox
hunterachieng Feb 6, 2025
51702b4
fix: update kobo example
hunterachieng Feb 6, 2025
45a9373
update example function
hunterachieng Feb 6, 2025
49e8c9a
update static examples
hunterachieng Feb 6, 2025
f4f192e
fix get submission example
hunterachieng Feb 7, 2025
a42f383
update submission example
hunterachieng Feb 7, 2025
db1bf7d
add cursor to example
hunterachieng Feb 7, 2025
a316e3a
modified comment explanation
aleksa-krolls Feb 9, 2025
dbf26a8
February updated
christad92 Feb 10, 2025
ea22a91
copy fixes
christad92 Feb 10, 2025
d372ed5
added prettier
christad92 Feb 10, 2025
88a88f6
Added product update calendar
christad92 Feb 11, 2025
02edd64
remove delivered, they go to product update
taylordowns2000 Feb 13, 2025
557f81b
Merge pull request #634 from OpenFn/feb-update
taylordowns2000 Feb 13, 2025
706f688
Merge pull request #633 from OpenFn/feat/970-kobo-examples
josephjclark Feb 14, 2025
48a22aa
Create intuit.md (#635)
daissatou2 Feb 15, 2025
ceecd2f
add search limitation
Feb 23, 2025
444c5c9
Add youtube playlist to adapters page (#641)
redietr Feb 28, 2025
5565476
Updated weekly meeting link to latest (#639)
christad92 Feb 28, 2025
bb84e60
Update README.md
taylordowns2000 Mar 7, 2025
25f1dac
Adaptor overview pages (#638)
daissatou2 Mar 7, 2025
93b7102
Adaptor overview pages (#631)
daissatou2 Mar 7, 2025
3612540
March roadmap update
christad92 Mar 7, 2025
4fc6f46
Added prettier and updated adaptors
christad92 Mar 7, 2025
1f90f86
Bump prismjs from 1.29.0 to 1.30.0
dependabot[bot] Mar 10, 2025
84f73ca
Added project concurrency note
christad92 Mar 11, 2025
106b113
prettier
christad92 Mar 11, 2025
5a308b0
removed new
christad92 Mar 11, 2025
2cf289a
Updated workflow session
christad92 Mar 11, 2025
ab2cc64
Updated docs
christad92 Mar 11, 2025
850cbf6
minor change
christad92 Mar 11, 2025
e1ad5e5
Minor
christad92 Mar 11, 2025
d246354
Omissions
christad92 Mar 11, 2025
e4800be
prettier
christad92 Mar 11, 2025
b9917f2
new project language
taylordowns2000 Mar 11, 2025
ab29ea5
Merge pull request #646 from OpenFn/march-update
taylordowns2000 Mar 11, 2025
c869c80
feat: add commcare example
hunterachieng Mar 17, 2025
23a78fa
Update limits (#647)
christad92 Mar 17, 2025
70d575b
Update commcare.md (#640)
AishaHassen Mar 17, 2025
b991a90
Merge pull request #650 from OpenFn/feature/972-commcare-examples
josephjclark Mar 18, 2025
dae7c4d
Fhir 4 Documentation (#637)
josephjclark Mar 20, 2025
56e1d8e
feat: add examples to satusehat
hunterachieng Mar 20, 2025
410e5cb
add link to AI webinsar
aleksa-krolls Mar 30, 2025
b8f4702
adding youtube video links
aleksa-krolls Mar 30, 2025
e653b10
new varo adaptor overview page
aleksa-krolls Mar 30, 2025
5cb8755
new adaptor overview docs for AI adaptors
aleksa-krolls Mar 30, 2025
a3f307c
edits to WF definition to reference relationship with AI
aleksa-krolls Mar 30, 2025
cb2c0b2
typo edit
aleksa-krolls Mar 30, 2025
a13592a
Merge pull request #652 from OpenFn/adaptor-updates-mar25
taylordowns2000 Mar 30, 2025
4a8c68c
formatting
taylordowns2000 Mar 30, 2025
e0502cc
Merge pull request #653 from OpenFn/adaptor-updates-mar25
taylordowns2000 Mar 30, 2025
7684e2d
fix: add better examples
hunterachieng Apr 1, 2025
ceaa470
log levels
taylordowns2000 Apr 2, 2025
4717e57
keywords
taylordowns2000 Apr 2, 2025
60e5ca2
Bump image-size from 1.1.1 to 1.2.1
dependabot[bot] Apr 2, 2025
589b84d
fix: update satusehat docs
hunterachieng Apr 7, 2025
361ca0e
Bump estree-util-value-to-estree from 3.1.2 to 3.3.3
dependabot[bot] Apr 8, 2025
3c4a7ef
openlmis: add clientId and secret in config documentation (#657)
hunterachieng Apr 8, 2025
44ced73
Update openlmis.md
aleksa-krolls Apr 8, 2025
aa3609d
Fix path for googlesheets and adaptors documentation
jyeshe Apr 7, 2025
e662cfb
Add instructions on how to setup a Google Oauth Client
jyeshe Apr 8, 2025
0b70736
add sharp-edges and beta to kafka
taylordowns2000 Apr 9, 2025
72ad04c
feat: Add create encounter and observations examples for satusehat
hunterachieng Apr 9, 2025
d3dc975
move docs to existing spots
taylordowns2000 Apr 10, 2025
a6b4ee1
Merge pull request #656 from OpenFn/oauth-docs
taylordowns2000 Apr 10, 2025
c48ccd1
Merge pull request #658 from OpenFn/dependabot/npm_and_yarn/estree-ut…
taylordowns2000 Apr 10, 2025
d80b7df
Merge pull request #645 from OpenFn/dependabot/npm_and_yarn/prismjs-1…
taylordowns2000 Apr 10, 2025
a413350
Merge pull request #654 from OpenFn/dependabot/npm_and_yarn/image-siz…
taylordowns2000 Apr 10, 2025
65a03a8
fix: format with prettier
hunterachieng Apr 10, 2025
de48217
fix: remove state.organizationid
hunterachieng Apr 10, 2025
f8994df
fix: add comment for storing resources
hunterachieng Apr 10, 2025
997be07
fix: simplify state.patient
hunterachieng Apr 10, 2025
7570666
fix: observation comment
hunterachieng Apr 10, 2025
fbf240a
fix: remove unused line
hunterachieng Apr 10, 2025
7c9b6cd
fix: add create condition and delete update encounter
hunterachieng Apr 10, 2025
c4bcc06
updated zero-persistence diagram and deployment option descriptions (…
aleksa-krolls Apr 12, 2025
584cdf4
fix: change from conditionsMappedData to conditions
hunterachieng Apr 14, 2025
124a09d
fix: add more context to example descriptions
hunterachieng Apr 14, 2025
b082a15
fix: reformat and update satusehat examples
hunterachieng Apr 14, 2025
a44efb8
fix: remove parse in examples
hunterachieng Apr 15, 2025
2a69f6e
Merge pull request #651 from OpenFn/feature/971-satusehat-examples
josephjclark Apr 15, 2025
0f5e46b
add update trigger for docsite embeddings
hanna-paasivirta Apr 22, 2025
214b07e
add comment
hanna-paasivirta Apr 23, 2025
9fe48a0
Merge pull request #669 from OpenFn/update-docs-embeddings-fixed
josephjclark Apr 23, 2025
c09eda1
update overview docs for openmrs 5
josephjclark Apr 10, 2025
5748000
have you ever seen american spelling, where is the vodka, where is ma…
josephjclark Apr 10, 2025
4243310
Bump versions (#671)
josephjclark Apr 23, 2025
9f32748
Merge pull request #664 from OpenFn/openmrs-5
taylordowns2000 Apr 24, 2025
9512ccc
Merge pull request #659 from OpenFn/olmis-patch
taylordowns2000 Apr 24, 2025
0a7fd69
remove video, add docs. new video coming now now
taylordowns2000 Jun 10, 2025
72fe3ec
video
taylordowns2000 Jun 10, 2025
b6def7c
v3, start
taylordowns2000 Jun 11, 2025
d73b16e
update authors
taylordowns2000 Jun 11, 2025
7855372
collections
taylordowns2000 Jun 11, 2025
13a5550
mor
taylordowns2000 Jun 11, 2025
8341d05
more
taylordowns2000 Jun 11, 2025
b4f25e0
mopre
taylordowns2000 Jun 11, 2025
7835e86
more
taylordowns2000 Jun 11, 2025
633cd60
fix links
taylordowns2000 Jun 11, 2025
8cafb30
Merge pull request #674 from OpenFn/v3
taylordowns2000 Jun 11, 2025
0b9ba0f
try redirect
taylordowns2000 Jun 13, 2025
9c30043
seo
taylordowns2000 Jun 14, 2025
a837f67
config
taylordowns2000 Jun 14, 2025
75b161d
remove old images
taylordowns2000 Jun 14, 2025
9743510
Save db job hif delete
taylordowns2000 Jun 14, 2025
f73e063
optimize images (#677)
taylordowns2000 Jun 14, 2025
7156fad
link to real roadmap
taylordowns2000 Jun 16, 2025
22984dd
fix openspp
taylordowns2000 Jul 2, 2025
8d27a30
Update openspp.md
taylordowns2000 Jul 2, 2025
1ab587b
Fix broken link images (#681)
mtuchi Jul 8, 2025
0c91755
Updates to collections description & zero persistence update (#667)
aleksa-krolls Jul 14, 2025
f846dd0
update kobo job code example (#685)
mtuchi Jul 23, 2025
f437cf0
opencrvs: implement opencrvs docs (#686)
hunterachieng Jul 23, 2025
985b764
Updates to commcare lookuptable docs (#688)
aleksa-krolls Jul 28, 2025
f47312a
Update lookup tables section in commcare.md (#689)
aleksa-krolls Jul 28, 2025
1956a2f
adding steps and edges
taylordowns2000 Jul 30, 2025
1ab3bcc
Keychain Credentials Update (#695)
theroinaochieng Aug 5, 2025
ad78e05
Adding Naming Dataclips (#696)
theroinaochieng Aug 6, 2025
4b68cf0
fix table formatting (#691)
mtuchi Aug 6, 2025
6789d91
more security content to address FAQs (#697)
aleksa-krolls Aug 12, 2025
6830ca1
pdfshift adaptor documentation (#698)
hunterachieng Aug 25, 2025
6484169
overview page for whatsapp adaptor (#702)
aleksa-krolls Aug 29, 2025
3811b23
impact tracker
taylordowns2000 Sep 11, 2025
cffc8d3
hash link update
taylordowns2000 Sep 11, 2025
21b9208
Update salesforce.md
mercy-ship-it Sep 17, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
22 changes: 22 additions & 0 deletions .github/workflows/trigger-embed.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Trigger Embed Service

on:
push:
branches:
- main

jobs:
trigger-embed:
runs-on: ubuntu-latest
steps:
- name: Trigger Embed Service
env: # The API keys are the same as those used by the AI Assistant. There is only one (production) database.
PINECONE_API_KEY: ${{ secrets.PINECONE_API_KEY }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
run: |
curl -X POST https://apollo.staging.openfn.org/services/embed_docsite \
-H "Content-Type: application/json" \
-d '{
"pinecone_api_key": "${{ secrets.PINECONE_API_KEY }}",
"openai_api_key": "${{ secrets.OPENAI_API_KEY }}"
}'
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ site._**

## Contributing to this documentation site

Visit https://docs.openfn.org/documentation/writing-docs/.
Visit: https://docs.openfn.org/documentation/writing-docs/

This website is built using [Docusaurus](https://docusaurus.io/), a static
website generator that uses Markdown and Javascript.
Expand Down
44 changes: 44 additions & 0 deletions adaptors/asana.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Asana Adaptor
---

## About Asana

[Asana](https://app.asana.com/) is a web-based project management tool that helps teams organize, plan, collaborate, and execute tasks.

## Integration Options

Asana supports 2 primary integration options:

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 [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 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.

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:

```
{
"apiVersion": "1.0",
"token": "sample-tokenyWSJdXBACMLLWMNGgADFA"
}
```

### Helpful Links

1. [API documentation](https://developers.asana.com/docs/overview)

### Implementation Examples

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




40 changes: 40 additions & 0 deletions adaptors/azure-storage.md
Original file line number Diff line number Diff line change
@@ -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-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:

```
{
"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!_




42 changes: 42 additions & 0 deletions adaptors/beyonic.md
Original file line number Diff line number Diff line change
@@ -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!_




50 changes: 50 additions & 0 deletions adaptors/bigquery.md
Original file line number Diff line number Diff line change
@@ -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!_




47 changes: 47 additions & 0 deletions adaptors/chatgpt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: ChatGPT AI Adaptor
---

## About ChatGPT

[ChatGPT](https://chatgpt.com/) is an AI assistant built by OpenAI. It provides
a family of large language models (LLMs) developed for natural language
processing tasks such as text generation, summarization, and question answering.

ChatGPT models process text input to generate responses but do not have built-in
memory or autonomous decision-making. They can be integrated with external tools
or APIs to execute actions beyond text-based outputs.

## Use OpenFn + LLMs for AI-Driven Workflows

While LLMs (like Claude or ChatGPT) can generate insights, recommendations, or
structured data, they often **lack direct execution capabilities**—meaning they
need an automation system to act on their outputs.

**OpenFn workflows fill this gap by orchestrating actions based on LLM-generated
responses.**

Remember that LLMs are imperfect. Learn more about your recommended approach to
AI in our [Responsible AI Policy](https://www.openfn.org/ai).

## Integration Options

Use this adpator to integrate with the
[OpenAI Platform API](https://platform.openai.com/docs/overview), to integrate
ChatGPT AI models into your workflows to leverage their natural language
processing (NLP) capabilities.

Example AI-driven workflow on OpenFn:
![ai-driven-workflow](/img/ai-workflow-example.webp)

## Authentication

See this adaptor's
[Configuration docs](/adaptors/packages/chatgpt-configuration-schema) for
technical docs on the authentication parameters required.

## Helpful Links

- About ChatGPT: https://chatgpt.com/
- API docs: https://platform.openai.com/docs/overview
- API Intro: https://www.chatbase.co/blog/chatgpt-api
45 changes: 45 additions & 0 deletions adaptors/claude.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Claude AI Adaptor
---

## About Claude

[Claude](https://claude.ai/) is an AI assistant built by Anthropic. It provides
a family of large language models (LLMs) developed for natural language
processing tasks such as text generation, summarization, and question answering.

Claude models process text input to generate responses but do not have built-in
memory or autonomous decision-making. They can be integrated with external tools
or APIs to execute actions beyond text-based outputs.

## Use OpenFn + LLMs for AI-Driven Workflows

While LLMs (like Claude or ChatGPT) can generate insights, recommendations, or
structured data, they often **lack direct execution capabilities**—meaning they
need an automation system to act on their outputs.

**OpenFn workflows fill this gap by orchestrating actions based on LLM-generated
responses.**

Remember that LLMs are imperfect. Learn more about your recommended approach to
AI in our [Responsible AI Policy](https://www.openfn.org/ai).

## Integration Options

Use this adpator to integrate with the
[Claude API](https://www.anthropic.com/api), to integrate Claude AI models into
your workflows to leverage their natural language processing (NLP) capabilities.

Example AI-driven workflow on OpenFn:
![ai-driven-workflow](/img/ai-workflow-example.webp)

## Authentication

See this adaptor's
[Configuration docs](/adaptors/packages/claude-configuration-schema) for
technical docs on the authentication parameters required.

## Helpful Links

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