FormSG Adaptor

About FormSG

FormSG is an open-source form builder developed by the Singapore Government's Open Government Products team to digitize paper processes for government agencies. It enables secure collection of up to Confidential (Cloud-Eligible) and Sensitive (High) data with end-to-end encryption.

Integration Options

FormSG supports webhook integration with OpenFn:

Webhooks: FormSG provides webhook functionality that enables real-time form submission data to be sent to external applications like OpenFn. Using the official FormSG JavaScript SDK, you can securely decrypt and process form submissions as they are received. This integration is suited for automated workflow triggers, real-time data processing, and applications that need immediate response to form submissions. The webhook system includes signature verification to ensure data authenticity and security. See functions for more on how to use this adaptor to work with FormSG webhooks.

Authentication

1. See FormSG SDK documentation for the latest on webhook authentication and signature verification methods.
2. When integrating with FormSG via OpenFn, you need a Form Secret Key which is generated when you create a form in FormSG. This key is used for decrypting submissions and verifying webhook signatures.
3. See this adaptor's configuration docs for more on the required authentication parameters.

See platform docs on managing credentials for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:

{
  "formSecretKey": "your-secret-key-here",
  "mode": "production",
  "webhookEndpoint": "https://my-domain.com/submissions"
}

Implementation Examples

Coming soon!

Report or fix a problem with this adaptor

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