FormWork documentation
Extensions & Integrations
Connect forms and workflows to built-in services and external APIs.
Extensions connect FormWork to other services. Built-in extensions can add specialised fields, workflow actions, and webhook handling. API Connectors provide reusable HTTP actions for an external API.
Built-In Extensions
Installed extensions are managed at project level:
- Open the project and select Extensions.
- Choose an available extension.
- Install it for the project.
- Add an environment and the credentials it requires.
- Enable the environment when it is ready for use.
An extension can expose one or more of:
- Builder field types, such as a payment field
- Workflow actions
- Entry-scoped actions
- Webhook handlers
The available features are listed on each extension’s setup page.
The current built-in catalogue includes Stripe, which adds a hosted Checkout payment field, payment-aware submission validation, Stripe webhook handling, and Stripe workflow actions. See Stripe.
API Connectors
Use an API Connector when a service has an HTTP API but no built-in extension action for the operation you need.
An API Connector defines:
- Shared actions, each with an HTTP method, path, inputs, and response schema
- Separate environments such as Sandbox and Live
- Environment-specific base URLs, authentication, secrets, headers, encoding, and timeouts
API Connectors are declarative. They do not upload executable code, add new public form field types, or register native webhook hooks.
Environments and Secrets
Keep test and live settings in separate environments. Each environment can use its own base URL and credentials while sharing the connector’s actions.
Secrets such as bearer tokens, API keys, and passwords are not exposed to respondents. After a secret is saved, the editor lets you replace it without displaying the existing value.
Only enabled environments are available to workflow steps and action tests. Give each environment an explicit name, such as CRM Sandbox or CRM Live, and confirm which one is the default.
An extension can have several environments. You can rename, enable/disable, make default, and delete them. Deleting the default makes the first remaining environment default. Some built-in extensions manage connection settings for you; API Connectors expose the environment controls documented in their own guide.
Workflow Actions
An extension or API Connector action appears in the workflow step chooser. Select the environment and action, then map current entry data or earlier step outputs into its inputs.
The action response becomes workflow output for downstream steps. Inspect the workflow run to see the selected path and the recorded request and response details.
Webhooks
Some built-in extensions can receive service-specific webhooks, for example a payment update. The extension owns validation and event handling for those endpoints.
An API Connector describes outbound HTTP actions; it does not create inbound webhook handlers. If an outside system needs to start a normal workflow, use an API Request Received trigger and the workflow API endpoint.
Choose the Right Integration
| Need | Use |
|---|---|
| A provider-specific field or webhook | Built-in extension |
| Call an external HTTP API from a workflow | API Connector |
| Let an external system manage FormWork resources | REST API |
| Let an external system start one workflow | API Request Received trigger |
Good Practices
- Keep Sandbox and Live credentials separate.
- Enable an environment only after its base URL and authentication are complete.
- Test an action in the connector before adding it to a workflow.
- Store durable external record IDs back on the entry or metafields.
- Inspect workflow runs and connector test history before retrying a failed request.