Wp-webhooks Python API Docs | dltHub

WP Webhooks is a WordPress plugin that enables creating webhook triggers and actions to send and receive data from a self‑hosted WordPress site. The REST API base URL is https://<your-wordpress-site> and Authentication is configured per site in the WP Webhooks plugin; supported methods: API Key, Bearer token, or HTTP Basic Auth..

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 Wp-webhooks data in under 10 minutes.

---

What data can I load from Wp-webhooks?

Here are some of the endpoints you can load from Wp-webhooks:

---

How do I authenticate with the Wp-webhooks API?

WP Webhooks credentials (API Key, Bearer token, or Basic Auth username/password) are generated and managed inside the WP Webhooks plugin UI on each WordPress site and must be included in incoming webhook/action requests as configured (e.g., X-API-KEY header, Authorization: Bearer , or standard Basic Auth).

1. Get your credentials

1. Log in to your WordPress admin for the site running WP Webhooks.
2. Open WP Webhooks plugin (Dashboard → WP Webhooks / Automations → Webhooks or Authentication settings).
3. Under Authentication or the specific webhook action, create or copy an API Key or token, or configure Basic Auth credentials for the action URL.
4. Use the generated key/token or Basic Auth credentials in your dlt source config when calling the site endpoints.

2. Add them to .dlt/secrets.toml

Copy
[sources.wp_webhooks_source]
api_key = "your_wp_webhooks_api_key_here"
# or for bearer
bearer_token = "your_wp_webhooks_bearer_token_here"
# or for basic auth
username = "wp_username"
password = "wp_password"

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 Wp-webhooks 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 wp_webhooks_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline wp_webhooks_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 get_posts and get_users from the Wp-webhooks 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 wp_webhooks_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://<your-wordpress-site>",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "get_posts", "endpoint": {"path": "wp-json/wpwh/v1/action/get_posts"}},
            {"name": "get_users", "endpoint": {"path": "wp-json/wpwh/v1/action/get_users"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="wp_webhooks_pipeline",
        destination="duckdb",
        dataset_name="wp_webhooks_data",
    )
    load_info = pipeline.run(wp_webhooks_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("wp_webhooks_pipeline").dataset()
sessions_df = data.get_posts.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM wp_webhooks_data.get_posts LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("wp_webhooks_pipeline").dataset()
data.get_posts.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 Wp-webhooks 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

If requests return authentication errors, verify the auth method configured for the webhook/action in the WP Webhooks plugin (API Key, Bearer or Basic). Ensure you send credentials in the header specified by the action (e.g., X-API-KEY or Authorization: Bearer ). Note: older plugin versions sometimes returned HTTP 200 with an error body on failed authentication — inspect response body for error messages.

Missing or unexpected data (data selector / mapping)

WP Webhooks responses are configurable per action; if your dlt pipeline finds no records, fetch the action URL in a browser or curl to inspect the exact JSON shape and identify the array/object key to use as the data_selector. The plugin allows mapping and changing response structure.

Base URL / endpoint not found (404)

Make sure WP Webhooks plugin is active on the target WordPress site and that you’re using the exact action URL presented by the plugin (the plugin shows the full action URL in the Receive Data / Action configuration). Some installations rename REST base routes; always copy the exact URL from the plugin UI.

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