No logo available for WHAPI Cloud to DuckDB connector icon

Load WHAPI Cloud data to DuckDB

Build a WHAPI Cloud to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the WHAPI Cloud API base URL, auth, endpoints, and incremental loading.

SourceWHAPI CloudWHAPI Cloud API DocumentationDestinationDuckDBIn-process analytical database. The default local destination for dlt pipelines.

WHAPI Cloud is a WhatsApp API platform for sending and receiving messages, managing groups, and building integrations using RESTful HTTP requests. Everything needed to build a working WHAPI Cloud → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.


Build your WHAPI Cloud to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

Prompt
Run uvx dlthub-init@latest to build a pipeline from WHAPI Cloud to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the WHAPI Cloud API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.


WHAPI Cloud API at a glance

Base URLhttps://gate.whapi.cloud
Example endpointGET messages/list
Authenticationall requests require a Bearer token — sent in the Authorization header, prefixed Bearer
PaginationOffset-based page size via count (default 100, max 500). The API uses offset-based pagination. The parameter for the page size (number of items) is 'count' and the parameter for the starting offset is 'offset'. Cursor-based pagination is not used.
Incremental fieldoffset
API referencehttps://whapi.readme.io/reference/sendmessagetext

These values come from the WHAPI Cloud API reference — the authoritative source if anything here looks out of date.


How do I authenticate with the WHAPI Cloud API?

Authentication is performed by including an Authorization header with the scheme Bearer followed by your API token (e.g., 'Authorization: Bearer <your_token>').

1. Get your credentials

  1. Sign up for a Whapi.Cloud account at https://panel.whapi.cloud/register. 2. Log in to your personal dashboard and create/connect a channel by scanning the QR code with your WhatsApp app (Settings -> Linked devices -> Link a device). 3. Navigate to the page of the authorized/connected channel within your dashboard. 4. Locate and copy your API key (token) directly from the channel page.

2. Add them to .dlt/secrets.toml

[sources.whapi_cloud_source] api_key = "your_whapi_cloud_api_token"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.


What WHAPI Cloud data can I load into DuckDB?

These are the WHAPI Cloud endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
messagesmessages/listGETGet a list of all received and sent messages
storiesstoriesGETGet list of stories
business_productsbusiness/productsGETGet business products
channelschannelsGETGet channels list
communitiescommunitiesGETGet communities list

How do I load only new WHAPI Cloud records?

WHAPI Cloud exposes offset on messages/list, so dlt can request only the records that changed since the last run. Set it as the cursor_path and dlt tracks the high-water mark for you between runs.

{"name": "messages", "endpoint": { "path": "messages/list", "incremental": {"cursor_path": "offset", "initial_value": "2024-01-01T00:00:00Z"}, }}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.


What does the generated WHAPI Cloud pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading messages and contacts from the WHAPI Cloud API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def whapi_cloud_source(api_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://gate.whapi.cloud", "auth": {"type": "bearer", "token": api_token}, }, "resources": [ {"name": "messages", "endpoint": {"path": "messages/list"}}, {"name": "stories", "endpoint": {"path": "stories"}} ], } yield from rest_api_resources(config) def load_whapi_cloud_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="whapi_cloud_pipeline", destination="duckdb", dataset_name="whapi_cloud_data", ) load_info = pipeline.run(whapi_cloud_source()) print(load_info) if __name__ == "__main__": load_whapi_cloud_to_duckdb()

Run it with python whapi_cloud_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.


How do I query WHAPI Cloud data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

import dlt data = dlt.pipeline("whapi_cloud_pipeline").dataset() df = data.messages.df() print(df.head())

SQL:

SELECT * FROM whapi_cloud_data.messages LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.


How do I deploy the WHAPI Cloud to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

  • Deploy & schedule — run the pipeline as a managed job with automatic retries.
  • Monitor — observable job queues, alerting, and load metrics for every run.
  • Transform — promote raw WHAPI Cloud loads into governed, documented models.
  • Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →


What other destinations can I load WHAPI Cloud data to?

dlt loads into any of these — only the destination argument changes:

DestinationExample value
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.


Next steps

Was this page helpful?

Community Hub

Need more dlt context for WHAPI Cloud to DuckDB?

Request dlt skills, commands, AGENT.md files, and AI-native context.