recaptchaFormConfig query

The recaptchaFormConfig query returns information about the reCaptcha configuration for the specified form type. You can use the recaptchaV3Config query to return a list of form types.

Syntax

recaptchaFormConfig(formType: ReCaptchaFormEnum!): ReCaptchaConfigOutput

References

The recaptchaFormConfig reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following query returns information about the reCaptcha configuration for the CONTACT form:

Request:

Copy
query {
    recaptchaFormConfig(formType:CONTACT) {
        is_enabled
        configurations {
        re_captcha_type
        badge_position
        website_key
        theme
        language_code
        minimum_score
        validation_failure_message
        technical_failure_message
      }
  }
}
Copied to your clipboard
query {
    recaptchaFormConfig(formType:CONTACT) {
        is_enabled
        configurations {
        re_captcha_type
        badge_position
        website_key
        theme
        language_code
        minimum_score
        validation_failure_message
        technical_failure_message
      }
  }
}

Response:

If reCaptcha is enabled for the specified form type, the response contains full configuration details.

Copy
{
  "data": {
    "recaptchaFormConfig": {
      "is_enabled": true,
      "configurations": {
        "re_captcha_type": "RECAPTCHA_V3",
        "badge_position": "inline",
        "website_key": "testtest",
        "theme": "light",
        "language_code": "en",
        "minimum_score": 0.5,
        "validation_failure_message": "Validation Failure Message",
        "technical_failure_message": "Technical Failure Message"
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "recaptchaFormConfig": {
      "is_enabled": true,
      "configurations": {
        "re_captcha_type": "RECAPTCHA_V3",
        "badge_position": "inline",
        "website_key": "testtest",
        "theme": "light",
        "language_code": "en",
        "minimum_score": 0.5,
        "validation_failure_message": "Validation Failure Message",
        "technical_failure_message": "Technical Failure Message"
      }
    }
  }
}

Otherwise, the configurations object contains a null response:

Copy
{
  "data": {
    "recaptchaFormConfig": {
      "is_enabled": false,
      "configurations": null
    }
  }
}
Copied to your clipboard
{
  "data": {
    "recaptchaFormConfig": {
      "is_enabled": false,
      "configurations": null
    }
  }
}

Last updated 4/2/2024

Was this helpful?

Yes

No