roamhq
Official Python SDK for the Roam API.
pip install roamhq
Requires Python 3.10+.
import os
from roamhq import RoamClient
client = RoamClient(token=os.environ["ROAM_TOKEN"])
result = client.chat.post(
group_id="88bebce7-6cbb-4666-96f9-5c02d73e6661",
text="Build completed successfully!",
)
Full usage — pagination, retries, error handling, version pinning — is in the SDK guide. The API reference documents every endpoint.
Verifying webhooks
from roamhq.webhooks import verify_webhook
event = verify_webhook(body, request.headers, os.environ["ROAM_WEBHOOK_SECRET"])
body must be the raw request bytes. Treat any exception as a 401. Pass
the signing secret exactly as Roam issued it, whsec_ prefix included.
This is the one part of the SDK that is hand-written rather than generated. See
src/roamhq/webhooks.py for why.
This repository is mostly generated
The client and types are generated from the Roam OpenAPI specification by Fern. Do not edit them by hand — the next regeneration will overwrite them.
A change to the spec opens or updates a single long-lived pull request here
titled "Regenerate SDK from OpenAPI spec". A human reviews the diff, picks the
semantic-version bump in pyproject.toml, and merges. Merging does not
publish to PyPI.
Everything listed in .fernignore is hand-maintained.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file roamhq-0.1.0.tar.gz.
File metadata
- Download URL: roamhq-0.1.0.tar.gz
- Upload date:
- Size: 198.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b72d8e7b686e329a7e950f2e16336b2b955b09b7942247a4307425f6671638b7
|
|
| MD5 |
dc2e3bdf86e8cbe0704e4ddc64713687
|
|
| BLAKE2b-256 |
2220374404cdce3b769c1e083e89afc2b0f445092a28bf86c915f73aaafb61f1
|
Provenance
The following attestation bundles were made for roamhq-0.1.0.tar.gz:
Publisher:
publish.yml on WonderInventions/roam-sdk-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
roamhq-0.1.0.tar.gz -
Subject digest:
b72d8e7b686e329a7e950f2e16336b2b955b09b7942247a4307425f6671638b7 - Sigstore transparency entry: 2693182057
- Sigstore integration time:
-
Permalink:
WonderInventions/roam-sdk-python@e035282488bdd9b7f92912a3f21e989c5a7b55b7 -
Branch / Tag:
refs/heads/master - Owner: https://github.com/WonderInventions
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@e035282488bdd9b7f92912a3f21e989c5a7b55b7 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file roamhq-0.1.0-py3-none-any.whl.
File metadata
- Download URL: roamhq-0.1.0-py3-none-any.whl
- Upload date:
- Size: 337.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b35f35c3a88d3519e3936caec00af5b421fbac251fc38f10c82eebc6d93abdd2
|
|
| MD5 |
39bacd52db48d6758d13e4061257b260
|
|
| BLAKE2b-256 |
b2b2376a32e5c08aaa2de61b109649ca620896a6160ad75ceb537ad31e8311d5
|
Provenance
The following attestation bundles were made for roamhq-0.1.0-py3-none-any.whl:
Publisher:
publish.yml on WonderInventions/roam-sdk-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
roamhq-0.1.0-py3-none-any.whl -
Subject digest:
b35f35c3a88d3519e3936caec00af5b421fbac251fc38f10c82eebc6d93abdd2 - Sigstore transparency entry: 2693182090
- Sigstore integration time:
-
Permalink:
WonderInventions/roam-sdk-python@e035282488bdd9b7f92912a3f21e989c5a7b55b7 -
Branch / Tag:
refs/heads/master - Owner: https://github.com/WonderInventions
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@e035282488bdd9b7f92912a3f21e989c5a7b55b7 -
Trigger Event:
workflow_dispatch
-
Statement type:
