Whatsapp-notifications Python API Docs | dltHub

Build a Whatsapp-notifications-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.

Last updated:

The WhatsApp Business Platform (Cloud API) allows businesses to send and receive messages at scale using Meta's infrastructure. The REST API base URL is https://graph.facebook.com and all requests require a Bearer token in the Authorization header.

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 add "dlt[hub]" and start loading Whatsapp-notifications data in under 10 minutes.


What data can I load from Whatsapp-notifications?

Here are some of the endpoints you can load from Whatsapp-notifications:

ResourceEndpointMethodData selectorDescription
messages/{phone-number-id}/messagesPOSTSend a message to a WhatsApp user.
conversations/{phone-number-id}/conversationsGETdataList conversations for the phone number.
phone_numbers/{whatsapp-business-account-id}/phone_numbersGETdataList phone numbers associated with the WABA.
message_templates/{whatsapp-business-account-id}/message_templatesGETdataList message templates for the WABA.
media/{media-id}GETRetrieve metadata for a specific media object.

How do I authenticate with the Whatsapp-notifications API?

All requests require an Authorization header with a Bearer token. The token must be a valid access token, such as a system user access token or temporary token, obtained through the Meta for Developers platform.

1. Get your credentials

  1. Navigate to the Meta for Developers Apps dashboard (https://developers.facebook.com/apps/) and select your Meta app. 2. In the left-side navigation menu, go to WhatsApp > API Setup. 3. To obtain a temporary access token for testing, copy the value provided under the Temporary access token field. 4. For production, navigate to Business Settings in your Meta Business Suite, click System Users, and create a new system user with access to your WhatsApp Business Account. 5. Select the system user, click Generate token, and ensure you assign the required permissions: whatsapp_business_messaging and whatsapp_business_management. 6. Copy the generated permanent access token and your WhatsApp Business Account ID for your configuration.

2. Add them to .dlt/secrets.toml

[sources.whatsapp_notifications_source] access_token = "REPLACE_ME"

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 init uv add "dlt[hub]"

1. Install the dlt AI harness:

uv run dlthub 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:

uv run dlthub ai toolkit install rest-api-pipeline

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-notifications 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:

uv run python whatsapp_notifications_pipeline.py

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

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

Inspect your pipeline and data:

uv run dlthub 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 /{version}/{phone-number-id}/messages and /{version}/{waba-id} from the Whatsapp-notifications 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_notifications_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://graph.facebook.com", "auth": {"type": "bearer", "token": access_token}, }, "resources": [ {"name": "conversations", "endpoint": {"path": "{phone-number-id}/conversations", "data_selector": "data"}}, {"name": "message_templates", "endpoint": {"path": "{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_notifications_pipeline", destination="duckdb", dataset_name="whatsapp_notifications_data", ) load_info = pipeline.run(whatsapp_notifications_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_notifications_pipeline").dataset() sessions_df = data.conversations.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM whatsapp_notifications_data.conversations LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("whatsapp_notifications_pipeline").dataset() data.conversations.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-notifications 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 harness:

  • data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
  • dlthub-platform — Deploy, schedule, and monitor your pipeline in production.
uv run dlthub ai toolkit install data-exploration uv run dlthub ai toolkit install dlthub-platform

Was this page helpful?

Community Hub

Need more dlt context for Whatsapp-notifications?

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

Available Pipelines