Skip to main content

AI Agents

Integrations​

AI Agents

TrueBeep ships a skill file — a single Markdown document that teaches any capable AI agent how to use the TrueBeep API. Point your agent at it once and it learns to manage loyalty customers, adjust points, and read your social analytics on your behalf.

The skill file lives at:

https://docs.truebeep.com/SKILL.md

It works with any agent that can read a URL and follow instructions, including:

  • Claude Code — Anthropic's CLI and IDE agent
  • OpenAI Codex — the Codex CLI / coding agent
  • Cursor — the AI code editor
  • Windsurf, Cline, Gemini CLI, and other AI coding assistants that support skills or custom instructions

Set it up in one message​

In your agent's chat, send:

set up https://docs.truebeep.com/SKILL.md

The agent will fetch the file, save it as a reusable skill, and enable it so it loads in future sessions. From then on, whenever you ask it to work with customers, loyalty points, or social analytics, it already knows the endpoints, the request formats, and the rules.

info

The skill file is versioned in its frontmatter, so agents re-run the setup step whenever a newer version is published and always operate with the latest TrueBeep instructions.

What the agent can do​

Manage Customers

Create single or bulk customers, update details, and look up records by ID.

Loyalty Points

Increment or decrement a customer's balance, or apply points from a scanned QR coupon.

Social Analytics

Pull post-level metrics, profile/page insights, and a cross-platform summary across all connected platforms.

Before you start: get a secret key​

The agent needs a TrueBeep API secret key to authenticate. Create one from the API page, then give it to your agent (or store it in an environment variable such as TRUEBEEP_API_KEY).

How the agent authenticates

Every request the agent makes includes your key as a bearer token:

Authorization: Bearer <token>

Requests are automatically scoped to the team that owns the key, so the agent only ever sees and modifies your own team's data. Never paste your key into shared or committed files — keep it in an environment variable or a secrets store.

caution

Point adjustments and QR redemptions change real customer balances. A well-behaved agent will confirm the customer, amount, and direction before making balance-changing calls — but you should review these actions, especially when running an agent unattended.

Try it​

Once the skill is set up and your key is in place, ask your agent things like:

  • "Create a TrueBeep customer named John Doe with email john.doe@example.com."
  • "Add 50 loyalty points to customer e8c43l37t1zayx8t66t5xbg9."
  • "Show me a 30-day cross-platform analytics summary for Facebook and Instagram."
  • "List my top-performing Instagram reels from last month."

Full API reference​

The skill file is a distilled guide for agents. For the complete, human-readable reference — every endpoint, parameter, and example in five languages — see:

Customer API

Create, update, retrieve customers and manage loyalty points.

Analytics API

Post, profile, and cross-platform social analytics.