Customer support
Front in your product and your AI agents, through one API
The Front toolkit covers conversations and their messages, tags, internal comments, drafts, replies, new messages, and the channels, inboxes and teammates they refer to. Through Connect your product or AI agent calls them with one endpoint, while Connect stores the API token and logs every execution.
15 days to try it. No credit card.
POST https://connect.reportei.com/api/tools/front_apply_tags/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"conversation_id": "<conversation_id>",
"tag_ids": []
}
}How it works
From a connected customer to the first Front call.
- 1
Your customer connects the account
Your system opens a Connect session for the toolkit and your customer connects their Front account. You get the connection id.
- 2
Your product calls the tool
A POST to /api/tools/{tool}/execute with the connection id and arguments. On success, Connect preserves the app's response status and body.
- 3
Connect handles the rest
It stores the credential encrypted, renews tokens for OAuth connections that support renewal and records executions in an audit trail available through the API.
Use cases
What your product does with Front.
Draft replies for review
An AI agent reads a conversation and creates a draft reply, so a teammate reviews and sends it in Front. Nothing goes out on its own.
Triage and route conversations
A support tool searches conversations, applies tags and updates the assignee or inbox.
Notify customers from your app
A product sends a new message from a channel or replies in an existing conversation when something happens in the app.
Tools
13 Front tools
- Search conversationsGETSearches the conversations the API token can reach, most recent activity first, and returns _total with the matches. Trashed conversations are left out unless the query asks for is:trashed. The next page comes from the page_token inside _pagination.next, which is null on the last page.
- Get conversationGETReturns a conversation with its subject, status, assignee, main recipient, tags, custom fields and links. The messages come from List conversation messages.
- List conversation messagesGETLists the messages of a conversation, newest first unless sort_order is asc, with author, recipients, subject, body and attachment details. The next page comes from the page_token inside _pagination.next, which is null on the last page.
- Update conversationPATCHUpdates the assignee, inbox, status, tags or custom fields of a conversation. Send only the fields to change. tag_ids replaces every tag of the conversation, so use Apply tags to add tags without removing the others.
- Apply tagsPOSTAdds one or more tags to a conversation and keeps the tags it already has.
- Create commentPOSTAdds an internal comment to a conversation. Comments are seen only by teammates, never by the contact. The body accepts Markdown.
- Create draftPOSTCreates a draft reply to the last message of a conversation, for a teammate to review and send in Front. Nothing is sent. A private draft is visible only to its author, so set author_id to the teammate who will review it, or use mode shared.
- Reply to conversationPOSTSends a reply in a conversation right away and answers 202 with a message_uid. Front archives the conversation when the reply goes out, unless options.archive is false. Needs the send permission on the API token. A merged conversation answers with a redirect to the conversation it was merged into.
- Send messagePOSTSends a new message from a channel, which starts a new conversation, and answers 202 with a message_uid. It goes out right away, and Front archives the new conversation unless options.archive is false. Needs the send permission on the API token.
- List channelsGETLists the channels of the company, such as email addresses, SMS numbers and chat, with id, name, address, type and the link to their inbox. The id is the channel_id of Send message and Create draft.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
Questions about the Front toolkit
Do I need to build against the Front API?
No. Connect ships 13 Front tools, described and ready. Your customer connects the account and your system calls every tool through the same endpoint, with the same request format.
How does my customer connect their Front account?
With the mode the toolkit accepts: API key. Connect stores the credential encrypted and never returns it to your system.
Does it work with AI agents?
Yes. Each tool's input is described in JSON Schema, which your agent uses directly as a tool definition. The agent picks the tool and the arguments, and your system makes the call to Connect.
Does my customer need a Reportei account?
No. Your customer connects the account on a Connect screen, or your system sends the credential through the API, and they keep using only your product.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
