canonical: https://jentic.com/apis/moxtra.com/moxo-api

# Moxtra Moxo API

Moxo (formerly Moxtra) is a customer interaction platform that powers branded client portals, deal rooms, and external workflow automation for financial services, professional services, and other client-facing teams. The Moxo API exposes 12 endpoints covering workspaces, workspace members, transactions, clients, files, e-signatures, notes, and flow steps, plus a button-clicked webhook for embedded flow buttons. Authentication uses OAuth 2.0 or an API key passed in the Authorization header.

## For AI agents

Provision client workspaces, manage transactions and members, attach files and notes, and orchestrate e-signatures and flow steps inside Moxo's collaboration platform.

## Scope

Does not handle public messaging, broadcast email, or accounting ledgers - use for branded client workspaces, transactions, files, e-signatures, and embedded flow automation only.

## Capabilities

- Create and manage client workspaces via /workspaces, including members through `/workspaces/{workspaceId}/members`
- Run flow step actions for embedded automation via `/workspaces/{workspaceId}/flows/{flowId}/steps`
- Manage end-clients of the platform via /clients and track structured deals through /transactions
- Upload and list files attached to a workspace via `/workspaces/{workspaceId}/files`
- Initiate e-signature requests on workspace documents via /esignatures
- Create notes on a workspace via `/workspaces/{workspaceId}/notes`
- Receive button-click webhook callbacks for embedded flow buttons via `/webhooks/flows/button-clicked`

## Use cases

### Branded Client Onboarding Workspace

Financial services and professional services firms onboard each new client into a dedicated Moxo workspace that holds documents, signatures, and chat history. The agent creates the workspace via /workspaces, adds the client and the firm's relationship manager via /members, uploads onboarding documents to /files, and kicks off an e-signature via /esignatures. The whole onboarding becomes a scriptable sequence rather than a manual portal click-through.

Example prompt: Create a workspace, add the client and an internal owner via `/workspaces/{workspaceId}/members`, upload an engagement letter via /files, and create an e-signature request via /esignatures.

### Deal Room Transaction Tracking

Deal rooms track structured transactions - a loan application, an account opening, a procurement step. The /transactions endpoint records and updates these and pairs with /workspaces and /flows for the surrounding collaboration. This gives a back-office system a single, coherent place to write transaction state without bespoke per-deal tooling.

Example prompt: Create a transaction tied to a workspace via /transactions, then advance the associated flow step via `/workspaces/{workspaceId}/flows/{flowId}/steps.`

### Embedded Button-Click Automation

Moxo's flows can include buttons that trigger backend automation when clicked. The `/webhooks/flows/button-clicked` endpoint receives the click event so the integrating system can act - approve a transaction, generate a document, or notify an agent. This makes Moxo a UI surface for backend agentic workflows.

Example prompt: Register the `/webhooks/flows/button-clicked` handler URL in your backend, then receive the button-click payload and dispatch the appropriate downstream action.

### Client-Service Agent via Jentic

An AI customer-service agent provisioning a new client portal searches Jentic for the workspace creation operation, loads its schema, and executes. Jentic injects the OAuth token or API key so the agent never holds raw Moxo credentials. The agent then chains follow-up calls - add members, upload files, request signatures - through the same Jentic flow.

Example prompt: Search Jentic for 'create a Moxo workspace', load /workspaces, and execute it with the new client's name and primary owner.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/workspaces` | Create a new workspace |
| POST | `/workspaces/{workspaceId}/members` | Add or manage workspace members |
| POST | `/workspaces/{workspaceId}/files` | Upload a file to a workspace |
| POST | `/workspaces/{workspaceId}/notes` | Add a note to a workspace |
| POST | `/workspaces/{workspaceId}/flows/{flowId}/steps` | Execute a flow step |
| POST | `/transactions` | Create a transaction |
| POST | `/clients` | Create a client |
| POST | `/esignatures` | Create an e-signature request |

## Key resources

- **Workspaces** — Create and manage client workspaces with members, files, notes, and flows.
- **Transactions** — Track structured transactions associated with workspaces.
- **Clients** — Manage end-client records in the platform.
- **Files** — Upload and list files inside a workspace.
- **E-Signature** — Initiate and manage e-signature requests on workspace documents.
- **Notes** — Create notes attached to a workspace.
- **Flows** — Drive flow steps and receive button-click webhook events.

## Why Jentic

- **Setup:** Wiring Moxo by hand means completing its OAuth2 flow or setting the API key in the Authorization header, then threading the workspace id through members, files, notes, and flow-step calls. Through Jentic you install once, import the Moxo API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Moxo puts the workspace id in the URL path (`/workspaces/{workspaceId}/...`), so a rule can pin your agent to one workspace: it can add members, files, and notes there and nothing else. You choose the operations it may call, so actions like creating transactions or e-signatures are not included unless you add them.
- **Credential handling:** Your Moxo OAuth token or API key is stored once, encrypted, by your own Jentic One instance and attached to the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a Moxo workspace' or 'upload a file to a workspace', and Jentic returns the matching operation with its input schema, so the agent acts without scanning Moxo's docs.

## Related APIs

- **Slack API** — Slack offers internal team collaboration rather than branded external client portals.
- **HubSpot API** — HubSpot manages the CRM record for clients whose deal lives inside a Moxo workspace.
- **Stripe API** — Stripe handles the actual payment leg of a transaction tracked in a Moxo workspace.

## FAQ

### What authentication does the Moxo API use?

Moxo accepts OAuth 2.0 or an API key passed in the Authorization header. Through Jentic, the credential lives in the encrypted vault and is attached to each request - agents never see the raw token or key in their context.

### Can I create a client workspace and add members via the Moxo API?

Yes. POST to /workspaces to create the workspace, then POST to `/workspaces/{workspaceId}/members` to add internal users and end-clients. The same workspace ID can then be used for files, notes, transactions, and e-signature requests.

### How do I send an e-signature request through Moxo?

Call POST /esignatures with the document and signer details. The request is associated with the workspace context so signers can sign in the branded portal.

### What are the rate limits for the Moxo API?

Moxo does not publish hard rate limits in the spec. Treat the API as per-tenant fair-use and back off on 429 responses; cache workspace member lists rather than re-reading them on every interaction.

### How do I create a workspace through Jentic?

Run pip install jentic, search 'create a Moxo workspace', load POST /workspaces, and execute it with the workspace name and owner. Jentic supplies the OAuth token or API key from your vault.

### Is the Moxo API free?

API access is part of the Moxo platform subscription and is not sold standalone. Pricing depends on the customer-interaction plan; contact Moxo for current tiers.

### Can I limit what my agent is allowed to do with the Moxo API?

Yes. Because you run Jentic One yourself, your own rules decide which Moxo operations and credentials the agent may use. Moxo puts the workspace id in the URL path (`/workspaces/{workspaceId}/...`), so you can pin the agent to a single workspace where it adds members via `/workspaces/{workspaceId}/members`, uploads files via `/workspaces/{workspaceId}/files`, and creates notes via `/workspaces/{workspaceId}/notes.` You choose the operations it may call, so higher-impact actions like creating a transaction via /transactions or an e-signature request via /esignatures are excluded unless you grant them.