reCAPTCHA Integration

Prev Next

Custom Google reCAPTCHA keys are required for any custom domain apps or for using the forms website script with a reCAPTCHA (not a robot) element.

Important Notes

  • If you are embedding a form with a reCAPTCHA element, you will need to set up the reCAPTCHA integration following the instructions below.

  • Public forms that do not have a reCAPTCHA element added will have a yellow warning at the top of the form builder. We highly recommend adding the 'Not a robot' element to your public form for enhanced security.

  • If your organization has not implemented a custom domain, you will need to use the system's default domains.

  • The approvals reCAPTCHA link to the Forms app must be added to the reCAPTCHA domain configuration.

Create reCAPTCHA Key

  1. Navigate to the Google admin reCAPTCHA page

  2. Add a Label Input field for entering a label, with guidance icon for assistance.

  3. Select Challenge (v2) (version 2), then select either the "I'm not a robot" Checkbox or the Invisible reCAPTCHA badge options Options for reCAPTCHA types including challenge and checkbox verification methods.

    • I'm not a robot Checkbox: Standard reCAPTCHA, requires the user to tick the box before they're allowed to submit their form, it may require the user to complete additional challenges before submitting if suspicious activity is detected.

    • Invisible reCAPTCHA badge: Works behind the scenes of the form, allowing most users to submit forms without any interaction, instead of a checkbox. A small card is displayed in the form to indicate that reCAPTCHA is active. If suspicious activity is detected, users may be asked to complete additional challenges, but typically, no action is needed.

  4. Add your Domains Input field for adding a domain in Google Cloud Platform interface.

    Notes:

    • The domain can be your website address.

    • You will need to whitelist any domain that is used to access the form, for example, if the form is embedded on your website, the website domain will need to be whitelisted. If the form is also used within a Process Automation and Digital Services app (for example, in forms that include approval workflows) then those app URLs will also need to be whitelisted.

  5. Click Submit The Submit button for the Google reCAPTCHA.


Set Up the reCAPTCHA Integration

  1. Sign in to your site

  2. Navigate to the Workspace menu and click Settings
    Navigation menu showing 'My Workspace' and 'Settings' options.

  3. Select Integrations

  4. Select Setup Integration on the reCAPTCHA card The Setup Integration button for reCAPTCHA

  5. Enter the fields for your key Form fields for reCAPTCHA integration, including site and secret keys, with validation options.

    • Label: Name your key

    • Integration Type: Select the reCAPTCHA type that you set up in Google

      • "I'm Not a Robot" Checkbox: Validate requests with the "I'm not a robot" checkbox

      • Invisible reCAPTCHA badge: Validate requests in the background

    • Site Key: Enter your site key

    • Secret Key: Enter the secret key (you will not be able to view it after saving)

  6. Click Save The Save button on the Mailgun integration card.

  7. The reCAPTCHA integration has been set up


Add a New Domain

Follow this section's instructions to add additional domains to your reCAPTCHA integration.

  1. Sign in to your site

  2. Navigate to the Workspace menu and click Settings
    Navigation menu showing 'My Workspace' and 'Settings' options.

  3. Select Integrations

  4. Select Edit Integration on the reCAPTCHA card reCAPTCHA interface with options to edit integration.

  5. Click Add Domain reCAPTCHA integration interface showing options to add domains and save settings.

  6. Enter the fields for your key and click Save Form fields for reCAPTCHA validation, including checkbox and site key input areas.

    • Label: Name your key

    • Integration Type: Select the reCAPTCHA type that you set up in Google

      • "I'm Not a Robot" Checkbox: Validate requests with the "I'm not a robot" checkbox

      • Invisible reCAPTCHA badge: Validate requests in the background

    • Site Key:

    • Secret Key: Enter the secret key (you will not be able to view it after saving)

  7. Navigate to Apps and select Manage on the app that you want to configure the reCAPTCHA for Manage button on the application card.

  8. Select the Developer Tools tab Navigation menu highlighting the Developer Tools section among other options.

  9. Enable Use custom domain reCAPTCHA and select the reCAPTCHA key you wish to use Settings for App URL and reCAPTCHA domain customization in a web application.

  10. Click Save The Save button on the app.

  11. The domain has been added, and you can now choose between multiple domains when configuring the reCAPTCHA key in an app (application) or environment


Environment and App (Application) reCAPTCHA Configuration

Now that the integration has been configured, you will need to link your reCAPTCHA key to either an environment or an app (application). If the form is being embedded into another website, then you will need to configure the reCAPTCHA key on the environment menu. If the form is being used within an app, then you will need to configure the reCAPTCHA key on the App menu.

The determining factor of whether for which reCAPTCHA is used is if the embed script contains a formsAppId. If the formsAppId is not present in the embed script, then the Environment reCAPTCHA key will be used; if the formsAppId is present in the embed script then the App reCAPTCHA key will be used.

Environment Configuration

  1. Sign in to your site

  2. Navigate to Advanced Tools and select Environments

  3. Select the environment you wish to configure reCAPTCHA for

  4. Navigate to the Developer Tools tab The Developer Tools tab at the top of the environments screen.

  5. Toggle the Use custom domain ReCAPTCHA switch on to enable reCAPTCHA for the environment Instructions for using custom domain reCAPTCHA in web forms with highlighted toggle option.

    If you have more than one reCAPTCHA domain, click the reCAPTCHA Domain dropdown and select the domain you would like to useReCAPTCHA settings with highlighted domain input field for custom configuration.

  6. Click Save to save your changes The Save button in the top right corner of the environments page.

  7. The environment reCAPTCHA has been configured, and any forms with a reCAPTCHA element will use your Google reCAPTCHA key

App (Application) Configuration

  1. Sign in to your site

  2. Navigate to Apps, then click Manage on the app that you want to configure reCAPTCHA for Manage button on the application card.

  3. Navigate to the Developer Tools tab The Developer Tools tab.

  4. Toggle the Use custom domain ReCAPTCHA switch on to enable reCAPTCHA for the app Settings page showing options for SAML integration and custom domain reCAPTCHA.

    If you have more than one reCAPTCHA domain, click the reCAPTCHA Domain dropdown and select the domain you would like to useSettings for App URL and reCAPTCHA domain customization in a web application.

  5. Click Save to save your changes The Save button on the app.

  6. The app reCAPTCHA has been configured, and any forms with a reCAPTCHA element will use your Google reCAPTCHA key