WhatsApp Business API Python API Docs | dltHub

Build a WhatsApp Business API-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

The WhatsApp Business API allows businesses to automate customer communication and integrate with CRM systems. It includes features for setting up product catalogs and connecting phone numbers. Pricing and messaging limits are managed by the platform. The REST API base URL is https://graph.facebook.com and All requests require a Meta Graph API access token (Bearer token or access_token query param)..

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 WhatsApp Business API data in under 10 minutes.


What data can I load from WhatsApp Business API?

Here are some of the endpoints you can load from WhatsApp Business API:

ResourceEndpointMethodData selectorDescription
phone_numbers{version}/{whatsapp_business_account_id}/phone_numbersGETdataList phone numbers owned by a WhatsApp Business Account (WABA).
phone_number{version}/{phone_number_id}GETGet metadata for a single phone number (object response).
message_templates{version}/{whatsapp_business_account_id}/message_templatesGETdataList registered message templates for the WABA.
media{version}/{media_id}GETRetrieve a media object by ID (returns object with url/ mime_type).
contacts{version}/{phone_number_id}/contactsGETdataCheck contact profile/status; returns contact entries (data array).

How do I authenticate with the WhatsApp Business API API?

Use a Meta Graph API access token. Provide it in the Authorization header as 'Bearer <ACCESS_TOKEN>' or as the 'access_token' query parameter on Graph API calls.

1. Get your credentials

  1. Sign in to https://developers.facebook.com. 2) Create an App (Business type) and add WhatsApp product. 3) In App Dashboard get the App ID and App Secret; generate a System User token or Business access token via Business Manager / System Users. 4) On your WhatsApp Business Account, assign phone numbers and generate a permanent access token (or use short-lived token and refresh). 5) For RadistWeb catalogs: enter App ID and App Secret in RadistWeb (Settings > Connections > WhatsApp Business API > Edit) and authorize Facebook as instructed.

2. Add them to .dlt/secrets.toml

[sources.whatsapp_business_api_source] access_token = "YOUR_META_ACCESS_TOKEN" app_id = "YOUR_FACEBOOK_APP_ID" app_secret = "YOUR_FACEBOOK_APP_SECRET" whatsapp_business_account_id = "YOUR_WABA_ID" phone_number_id = "YOUR_PHONE_NUMBER_ID"

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:

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

1. Install the dlt AI Workbench:

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:

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 WhatsApp Business API 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:

python whatsapp_business_api_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline whatsapp_business_api_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 phone_numbers and message_templates from the WhatsApp Business API API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def whatsapp_business_api_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://graph.facebook.com", "auth": { "type": "bearer", "access_token": access_token, }, }, "resources": [ {"name": "phone_numbers", "endpoint": {"path": "{version}/{whatsapp_business_account_id}/phone_numbers", "data_selector": "data"}}, {"name": "message_templates", "endpoint": {"path": "{version}/{whatsapp_business_account_id}/message_templates", "data_selector": "data"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="whatsapp_business_api_pipeline", destination="duckdb", dataset_name="whatsapp_business_api_data", ) load_info = pipeline.run(whatsapp_business_api_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):

import dlt data = dlt.pipeline("whatsapp_business_api_pipeline").dataset() sessions_df = data.phone_numbers.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM whatsapp_business_api_data.phone_numbers LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("whatsapp_business_api_pipeline").dataset() data.phone_numbers.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 WhatsApp Business API data to?

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

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

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


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.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for WhatsApp Business API?

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