Wpforms Python API Docs | dltHub

WPForms is a WordPress form builder plugin that collects form submissions and can send them to external APIs via addons or plugins. The REST API base URL is https://{your-wordpress-site}/ (no centralized WPForms API) and No vendor‑wide API authentication; integrations use the target API’s authentication configured in webhook or connector settings..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Wpforms data in under 10 minutes.

---

What data can I load from Wpforms?

Here are some of the endpoints you can load from Wpforms:

---

How do I authenticate with the Wpforms API?

WPForms itself does not issue API keys. To push data, configure the Authorization header (Bearer, Basic, or custom) in the Webhooks/connector settings. To pull data, protect a custom REST endpoint with WordPress Application Passwords, Basic Auth, or a secret header.

1. Get your credentials

1. For push integrations: Open the target API’s dashboard (e.g., HubSpot, Salesforce) and generate an API token or secret. 2. In WPForms → Settings → Integrations → Webhooks, paste the token into the “Authorization” header field. 3. For pull integrations: In WordPress admin, go to Users → Profile → Application Passwords, generate a new password, and note the username/password pair. Use these credentials to protect your custom WPForms REST endpoint.

2. Add them to .dlt/secrets.toml

Copy
[sources.wpforms_source]
api_key = "your_api_key_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Wpforms API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python wpforms_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline wpforms_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset wpforms_data
The duckdb destination used duckdb:/wpforms.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline wpforms_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads entries and forms from the Wpforms API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def wpforms_source(auth_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{your-wordpress-site}/ (no centralized WPForms API)",
            "auth": {
                "type": "api_key",
                "api_key": auth_token,
            },
        },
        "resources": [
            {"name": "forms", "endpoint": {"path": "wp-json/wpforms/v1/forms", "data_selector": "forms"}},
            {"name": "entries", "endpoint": {"path": "wp-json/wpforms/v1/entries", "data_selector": "entries"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="wpforms_pipeline",
        destination="duckdb",
        dataset_name="wpforms_data",
    )
    load_info = pipeline.run(wpforms_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("wpforms_pipeline").dataset()
sessions_df = data.entries.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM wpforms_data.entries LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("wpforms_pipeline").dataset()
data.entries.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Wpforms data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication failures (401/403)

When the target API rejects the Authorization header, the webhook request returns 401 or 403. Verify the token/secret is correct and has the required scopes.

Webhook delivery errors (4xx/5xx)

If the request URL is wrong or the receiving server is down, WPForms logs a 4xx/5xx response. Check the webhook URL, SSL certificate, and server logs.

Missing Webhooks Addon (license restriction)

The Webhooks addon is only available to Elite license holders. Without it, no outgoing requests can be configured.

No GET endpoints for entries

WPForms does not provide a native GET API. To pull data you must install a plugin that exposes REST endpoints (e.g., rest‑interface‑for‑wpforms) or build a custom endpoint.

Signature/secret mismatches

When a secret is configured, WPForms adds an HMAC signature header. If the receiving service expects a different algorithm or secret, verification fails.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack