Overview

The Payload reCAPTCHA v3 Plugin is a plugin for Payload, a platform that allows the creation of APIs for web applications. This plugin is designed to protect collection operations in Payload using Google reCAPTCHA v3.

Features

• Protect Operations: The plugin allows you to protect collection operations in Payload by integrating Google reCAPTCHA v3.
• Compatible with Payload: The major version of the plugin must match the major version of the Payload for proper installation and functionality.
• Plugin Options: The plugin provides options such as the secret key and error handling function.

Installation

To install the Payload reCAPTCHA v3 Plugin, follow these steps:

1. Determine the compatible plugin version based on the major version of Payload.
2. In the plugins array of your Payload config file, call the plugin with the required options:
   • secret: Your Google reCAPTCHA v3 secret key (required).
   • errorHandler: Optional function that throws exceptions. By default, it throws Forbidden when the response from Google is not a success.

Summary

The Payload reCAPTCHA v3 Plugin is a valuable tool for protecting collection operations in Payload using Google reCAPTCHA v3. By integrating this plugin, you can add an extra layer of security to your Payload API and ensure that only valid reCAPTCHA tokens are accepted. Installation is straightforward, requiring the matching major version of the plugin and Payload, along with the necessary configuration options. Overall, this plugin enhances the security of your Payload-powered web applications.