No logo available for Mattermost to DuckDB connector icon

Load Mattermost data to DuckDB

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

SourceMattermostMattermost API DocumentationDestinationDuckDBIn-process analytical database. The default local destination for dlt pipelines.

Mattermost is an open-source platform for team communication that provides a REST API for managing users, channels, posts, and team workflows. Everything needed to build a working Mattermost → 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 Mattermost 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 Mattermost 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 Mattermost 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.


Mattermost API at a glance

Base URLhttps://your-mattermost-url.com/api/v4
Example endpointGET teams/{team_id}/channels
Authenticationall requests require an Authorization header with a Bearer token — sent in the Authorization header, prefixed Bearer
PaginationNot paginated
Incremental fieldpage
Record idid
API referencehttps://developers.mattermost.com/integrate/reference/rest-api/

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


How do I authenticate with the Mattermost API?

Authentication is performed by including an access token in the 'Authorization' header using the 'Bearer' scheme (e.g., 'Authorization: Bearer ').

1. Get your credentials

  1. As a System Admin, navigate to System Console > Integrations > Integration Management and ensure 'Enable Personal Access Tokens' is set to true. 2. If the user is not an admin, go to System Console > User Management > Users, select the user, choose 'Manage Roles', and enable 'Allow this account to generate personal access tokens'. 3. The user must then log in to their account and navigate to Profile (or Account Settings) > Security > Personal Access Tokens. 4. Click 'Create Token', provide a description, and copy the generated token immediately as it cannot be viewed again.

2. Add them to .dlt/secrets.toml

[sources.mattermost_source] base_url = "https://your-mattermost-url.com" api_token = "your_personal_access_token_here"

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 Mattermost data can I load into DuckDB?

These are the Mattermost endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
teams/teamsGETGet a list of teams
team_members/teams/{team_id}/membersGETGet a page of team members
public_channels/teams/{team_id}/channelsGETGet a page of public channels
private_channels/teams/{team_id}/channels/privateGETGet a page of private channels
users/usersGETGet a list of users

How do I load only new Mattermost records?

Mattermost exposes page on teams/{team_id}/channels, 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": "public_channels", "endpoint": { "path": "teams/{team_id}/channels", "incremental": {"cursor_path": "page", "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 Mattermost pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading users/me and posts from the Mattermost API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def mattermost_source(api_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://your-mattermost-url.com/api/v4", "auth": {"type": "bearer", "token": api_token}, }, "resources": [ {"name": "public_channels", "endpoint": {"path": "teams/{team_id}/channels"}}, {"name": "team_members", "endpoint": {"path": "teams/{team_id}/members"}} ], } yield from rest_api_resources(config) def load_mattermost_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="mattermost_pipeline", destination="duckdb", dataset_name="mattermost_data", ) load_info = pipeline.run(mattermost_source()) print(load_info) if __name__ == "__main__": load_mattermost_to_duckdb()

Run it with python mattermost_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 Mattermost 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("mattermost_pipeline").dataset() df = data.public_channels.df() print(df.head())

SQL:

SELECT * FROM mattermost_data.public_channels LIMIT 10;

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


How do I deploy the Mattermost 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 Mattermost 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 Mattermost 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 Mattermost to DuckDB?

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