Documentation
Set up the WordPress plugin, understand every decision, manage your account, and call the API from anything else.
Start here
Getting started
From sign-up to a protected WordPress site in about ten minutes.
The WordPress plugin
Installing the plugin, its four screens, every setting, and what happens if Cayve can't be reached.
Held messages
How held and blocked messages work in WordPress, how to release one, and how long each is kept.
Decisions, scores and rules
What allowed, held and blocked mean, how the 0 to 100 score works, and how to set each site's rules.
API reference
One POST per submission returns allow, hold or block, a score and the reasons. Every endpoint, field and error.
Troubleshooting
Fixes for the most common problems: connection errors, missing emails, and messages Cayve got wrong.
Start
- Getting startedFrom sign-up to a protected WordPress site in about ten minutes.
WordPress
- The WordPress pluginInstalling the plugin, its four screens, every setting, and what happens if Cayve can't be reached.
- Held messagesHow held and blocked messages work in WordPress, how to release one, and how long each is kept.
- IntegrationsEvery form plugin and WordPress feature the plugin protects, and what happens to a held or blocked submission in each.
- Plugin updatesHow the plugin updates itself, why every release is signed, and how to switch automatic updates off.
How it works
- Decisions, scores and rulesWhat allowed, held and blocked mean, how the 0 to 100 score works, and how to set each site's rules.
- Shadow modeWatch Cayve's decisions on your own site before it acts on any of them.
- How Cayve learnsYour corrections, signals shared across sites, and the scrubbed copies that improve detection.
Account
- Sites and keysAdding sites, creating and revoking keys, live versus test keys, and connecting a site.
- Team and rolesInviting people to your account and what owners, admins and members can do.
- Usage and billingWhat counts as a check, what happens if you go over, and how to change plans.
- Ask CayveThe assistant in your dashboard that answers questions about your own account.
- Privacy and your dataWhat Cayve receives from your sites, how long each part is kept, and the switches you control.
API
- API referenceOne POST per submission returns allow, hold or block, a score and the reasons. Every endpoint, field and error.
- API examplesChecking a submission from Node.js, PHP and Python, with a time limit and a safe fallback.
Help
- TroubleshootingFixes for the most common problems: connection errors, missing emails, and messages Cayve got wrong.