# FormSG

## What is FormSG?

FormSG is a self-service, easy-to-use and feature rich form builder that enables public officers to collect citizen data quickly and securely. Since launching in September 2017, FormSG has replaced almost 200 million paper form submissions and is used by over 160 public agencies. More than 150 thousand public officers are users of FormSG today.

More information about FormSG can be found [here](https://guide.form.gov.sg/)

## Choose form to connect

Only forms that fulfil the requirements below can be connected to Plumber

* Storage mode
* Form should be open to responses
* Restricted and Sensitive Normal

{% hint style="warning" %}
**Note: One form can only connect to one Pipe at a time.**
{% endhint %}

## Connecting FormSG to Plumber

1. Click "Choose how you want your workflow to start"<br>

<figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FlEn87OCT2KYn0Ho8313g%2Fimage.png?alt=media&#x26;token=74c4ee42-c981-4f84-b250-85c7ed17c6ff" alt=""><figcaption></figcaption></figure>

2. Click "FormSG"

<figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FhBo3q2xxD1f6v2triILf%2Fimage.png?alt=media&#x26;token=37a6dc4c-7941-48fa-a379-49018236c248" alt=""><figcaption></figcaption></figure>

3. Click "+ Add new form"&#x20;

<figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2F9nF9nXp2xFCsHbUjyrxg%2Fimage.png?alt=media&#x26;token=96f94f5a-57cb-4415-8f12-b3ab55249e35" alt=""><figcaption></figcaption></figure>

4. When the pop-up appears, fill in the Form URL in this format: "<https://form.gov.sg/654ab1234abc1a012345f1e0b>" and enter the respective secret key under "Form Secret Key".

<figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2F2HEvGeWkxyNFe6cxovCT%2Fimage.png?alt=media&#x26;token=43abce92-8e3d-4c59-8955-8f66988360dd" alt=""><figcaption></figcaption></figure>

5. Click "Connect"
6. A message stating "Connected to ..." will be shown along with a green light on the left. This means it has connected to the form successfully.

   <figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FwPbW1HpwbeBkhg1mUzyn%2Fimage.png?alt=media&#x26;token=a29afb82-05bf-4ba6-a0fd-96b9557f871b" alt=""><figcaption></figcaption></figure>
7. Click "Check step" and Plumber will generate mock data for you to use to build pipes.

## Common errors when connecting

<details>

<summary>We couldn't verify your webhook settings</summary>

<figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FWYLMg5eOFJNMc27LsnxZ%2FScreenshot%202025-08-01%20at%208.58.43%E2%80%AFAM.png?alt=media&#x26;token=5dace239-3393-4937-b66b-3054ca20369c" alt=""><figcaption></figcaption></figure>

This could be due to one of these reasons:\
\- your plumber account email is not registered with FormSG\
\- your form credentials are invalid or form is not public\
\- a server error on our side (contact us!)

</details>

<details>

<summary>The form you are trying to connect is currently being used in another pipe. Continuing with this connection will cause the other pipe to break.</summary>

Ensure that current pipe is no longer in use before proceeding.

</details>

<details>

<summary>The form is currently connected to a different endpoint. Continuing with this connection will override this setting.</summary>

You may have set your form webhook endpoint to something else that is not a plumber webhook endpoint. Proceeding with the connection will no longer allow the current webhook endpoint to receive further submissions.

</details>

## Check step

The **Check step** button generates mock responses based on your form fields. This allows you to verify that Plumber has connected the correct form with the correct fields.&#x20;

## Refreshing FormSG fields

If you make changes to your FormSG after connecting it to Plumber, the updated fields will not be reflected automatically. You will need to run the Check step again to retrieve the latest questions.

* If you do not wish to make a new submission, click “**Use mock data**” to load the latest fields.
* If you prefer to use a real submission, submit a new response to your form, then click “**Check with last submission**” again.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://guide.plumber.gov.sg/user-guides/start-the-workflow/formsg.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.