Customer support
Intercom in your product and your AI agents, through one API
The Intercom toolkit covers contacts (users and leads), conversations with replies and assignment, outbound messages, and the teammates and teams of a workspace. Your customer connects Intercom once with OAuth, and your product or AI agent calls each operation through Connect, which stores and renews the credentials and logs every execution.
15 days to try it. No credit card.
POST https://connect.reportei.com/api/tools/intercom_search_contacts/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"query": {}
}
}How it works
From a connected customer to the first Intercom call.
- 1
Your customer connects the account
Your system opens a Connect session for the toolkit and your customer connects their Intercom 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 Intercom.
Keep contacts in sync
Create or update Intercom contacts with their custom attributes when users sign up or change plans in your product.
Support agent triages inbox
An AI agent searches open conversations assigned to a team, reads each one, replies as a teammate and closes or snoozes it.
Proactive outreach from your app
Send a message to a contact in the Messenger or by email when something happens in your product, such as a failed payment.
Tools
13 Intercom tools
- List contactsGETLists the contacts of the workspace, users and leads, 10 per page by default. The next page comes from pages.next.starting_after in the response; without it, this is the last page. Merged contacts do not appear.
- Search contactsPOSTSearches contacts by their attributes, for example by email, role or a custom attribute. Timestamps are Unix seconds in UTC. Returns total_count and data, 50 per page by default, and the next page comes from pages.next.starting_after. A contact created in the last few minutes may not show up yet.
- Get contactGETReturns one contact with role, email, phone, name, owner_id, custom_attributes, tags, companies and location. A contact merged into another returns 410.
- Create contactPOSTCreates a contact, a user or a lead. Send at least one of email, external_id or role. Every custom attribute sent must already exist in the workspace, or Intercom refuses the contact.
- Update contactPUTUpdates a contact: send only the fields to change. A user cannot become a lead. Every custom attribute sent must already exist in the workspace.
- List conversationsGETLists the conversations of the workspace, 20 per page by default. The next page comes from pages.next.starting_after in the response; without it, this is the last page. Get conversation returns all the parts of one conversation.
- Search conversationsPOSTSearches conversations by their attributes, for example the open ones assigned to a teammate or a team. Timestamps are Unix seconds. Returns total_count and conversations, 20 per page by default, and the next page comes from pages.next.starting_after.
- Get conversationGETReturns one conversation with its parts (messages, notes and actions), up to the 500 most recent ones, plus state, assignees, contacts and tags.
- Create conversation replyPOSTReplies to a conversation as a teammate. A comment goes to the contact through the channel of the conversation, such as the Messenger or email; a note stays internal, visible only to teammates. Closing, snoozing, reopening and assigning are done by Manage conversation.
- Manage conversationPOSTCloses, snoozes, reopens or assigns a conversation. close needs type admin; snoozed needs snoozed_until; assignment needs type and assignee_id, and a conversation can have an admin and a team assigned at the same time. Assigning a closed conversation reopens it unless skip_reopen is true.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/intercom, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
Questions about the Intercom toolkit
Do I need to build against the Intercom API?
No. Connect ships 13 Intercom 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 Intercom account?
With the mode the toolkit accepts: OAuth with your product's app. 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.
