Skip to content
← Public packages

@kentcdodds/groupme

GroupMe REST API helpers for listing groups, reading messages, ranking activity, and preparing relevance-filtered digests for Kody agents.

README.md

37 lines · 1.4 KB · Markdown

@kentcdodds/groupme

Intent

GroupMe REST API helpers for listing groups, reading messages, ranking activity, and preparing relevance-filtered digests for Kody agents. One compact authenticated request helper talks to api.groupme.com/v3; domain helpers rank activity and shape digests. GroupMe does not publish an OpenAPI spec.

What it does

  • Verify OAuth auth and sample recent group activity
  • List groups and rank the most active ones
  • Page or date-window messages for a group
  • Filter messages by keywords, senders, mentions, or attachment types
  • Shape digest input for agent summarization
  • Low-level authenticated request escape hatch for any v3 path

Read-only helpers only — this package does not post messages.

Prerequisites / setup

  1. Connect the groupme OAuth integration (or open the guide export for connect URLs).
  2. User secret groupmeAccessToken (sent as X-Access-Token).
  3. Application client id user value: groupme-client-id.
  4. Approve hosts: api.groupme.com, oauth.groupme.com, image.groupme.com.
  5. Agents: see AGENTS.md for import paths, smoke-test, and paging limits.

Never paste the access token value into chat or docs.

Done when

  • smoke-test returns { ok: true } with the authenticated user
  • list-groups / list-most-active-groups return expected groups
  • prepare-digest returns a filtered window for a known group name when needed