Public forms

Forms are an app of the site, not a core feature. The owner turns the app on per site, in the admin; the default is uninstalled. Without the app the site shows no forms and receives no submissions.

Who receives the submission

The form is rendered and submitted by the site itself, on its own domain. The visitor’s anonymous submission does not go through api.canverly.com: the site relays it to the forms service, identifying itself by its domain. That is why there is no API key for “submitting a form”.

Note

Uninstalling the app deletes nothing: forms and leads stay stored and come back intact when the app is reinstalled.

Reading the leads

Submissions become leads, and an external system reads them through the content API with a ck_ key that carries the leads:read scope:

• GET /v1/leads: paginated list.
• GET /v1/leads/{id}: one lead.

Both routes have their own, lower limit (a lead is personal data). Details, fields and examples in Leads.

Receiving each lead right away

To avoid polling the list, set up a webhook: every new lead is delivered to an HTTPS endpoint of yours, signed with HMAC.