Skip to main content
Agents can use the Bevits REST API to answer questions about customers, segments, purchases, flows, and campaigns. Each API key can access only the organization it belongs to.
Give the agent a dedicated key with the read scope. Do not paste the key into prompts, versioned files, or logs; provide it through an environment variable or the platform’s secret manager.

​
Custom connections

When configuring a custom connection in an agent platform, use: Validate the connection with GET /me first. The returned organization.id is the connection’s stable identity.

​
Claude Code and Codex

For Claude Code and Codex, the recommended path is the Bevits MCP server: the connection uses OAuth, no API key is stored in the configuration, and the agent gets 20 read-only tools out of the box. If you prefer to use the REST API directly, Claude Code and Codex can also call it through their terminal tools. Start the tool with the variable available in its environment:
Then provide an instruction such as:
To answer “who are the best customers in the VIP segment and what did they buy?”, the agent can use only three steps:
  1. GET /segments?q=VIP to find the segment.
  2. GET /segments/{segment_id}/customers?sort=total_spent to rank its customers.
  3. GET /customers/{customer_id}/purchases to query the selected customer’s purchases.
Instruct the agent to preserve IDs exactly as returned and to request human confirmation before any action outside the read-only endpoints.