home/veldform/docs

Veldform / Docs

Connections

A connection is a reusable set of API credentials: a base URL plus the authentication that goes with it. You set it up once, and use it everywhere — in actions, payments and API prefill.

Secrets are encrypted at rest and never sent back to the browser. When you edit a connection, leaving a secret field empty keeps the stored value.

You'll find them under Veldform -> Connections.

Adding a connection

Click Add connection. You can pick a preset for a known service, or set one up by hand.

Service presets

Presets ask only for what's needed — usually just an API key — and take care of the right headers and base URL for you:

Service What you need
Mailchimp API key (Mailchimp -> Account -> Extras -> API keys)
Kit (ConvertKit) API key (Kit -> Settings -> Developer)
ActiveCampaign Account name + API key (Settings -> Developer)
Brevo API key (Brevo -> SMTP & API)
MailerLite API key (MailerLite -> Integrations -> API)
Airtable Personal access token
HubSpot Private app token
Notion Integration secret
Stripe Secret key, optionally the webhook signing secret
Mollie API key
WordPress Site URL, username and an application password

Note that Mailchimp, Kit, Stripe and Mollie have dedicated actions. For the other services you point a Send to external API action at the connection — see Custom API's.

API key / Bearer token

For any other API with a static key, use the API key (custom header) preset (set the header name, e.g. X-Api-Key) or the Bearer token preset. Both take an optional base URL.

OAuth2

For APIs that use OAuth2, pick the OAuth2 option. Both grant types are supported:

  • Client credentials — fill in the Client ID, Client secret, Token URL and optionally a scope.
  • Authorization code — additionally fill in the Authorization URL. The edit screen shows the redirect URL you need to register with the provider. Save the connection first, then click Connect to go through the provider's consent screen.

Tokens are refreshed automatically.

Custom API

The Custom API option gives you full control: a base URL, an auth type and free-form headers.

Using a connection

Wherever a connection can be used, you'll get a dropdown to pick one. Service-specific actions (like Mailchimp) only list matching connections, and offer an inline Connect... option so you can create one on the spot without leaving the form builder.

Developers can register their own connection presets via the veldform/connection_presets filter — see Action and filter hooks.