Skip to main content

Airbyte Intercom Connector for AI platforms

Project description

Intercom agent connector

Intercom is a customer messaging platform that enables businesses to communicate with customers through chat, email, and in-app messaging. This connector provides read-only access to core Intercom entities including contacts, conversations, companies, teams, admins, tags, and segments for customer support analytics and insights.

Example questions

The Intercom connector is optimized to handle prompts like these.

  • List all contacts in my Intercom workspace
  • List all companies in Intercom
  • What teams are configured in my workspace?
  • Show me all admins in my Intercom account
  • List all tags used in Intercom
  • Show me all customer segments
  • Show me details for a recent contact
  • Show me details for a recent company
  • Show me details for a recent conversation
  • Show me conversations from the last week
  • List conversations assigned to team {team_id}
  • Show me open conversations

Unsupported questions

The Intercom connector isn't currently able to handle prompts like these.

  • Create a new contact in Intercom
  • Send a message to a customer
  • Delete a conversation
  • Update company information
  • Assign a conversation to an admin
  • Create a new tag

Installation

uv pip install airbyte-agent-intercom

Usage

Connectors can run in open source or hosted mode.

Open source

In open source mode, you provide API credentials directly to the connector.

from airbyte_agent_intercom import IntercomConnector
from airbyte_agent_intercom.models import IntercomAuthConfig

connector = IntercomConnector(
    auth_config=IntercomAuthConfig(
        access_token="<Your Intercom API Access Token>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@IntercomConnector.tool_utils
async def intercom_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

from airbyte_agent_intercom import IntercomConnector, AirbyteAuthConfig

connector = IntercomConnector(
    auth_config=AirbyteAuthConfig(
        external_user_id="<your_external_user_id>",
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@IntercomConnector.tool_utils
async def intercom_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Full documentation

Entities and actions

This connector supports the following entities and actions. For more details, see this connector's full reference documentation.

Entity Actions
Contacts List, Get, Search
Conversations List, Get, Search
Companies List, Get, Search
Teams List, Get, Search
Admins List, Get
Tags List, Get
Segments List, Get

Authentication and configuration

For all authentication and configuration options, see the connector's authentication documentation.

Intercom API docs

See the official Intercom API reference.

Version information

  • Package version: 0.1.66
  • Connector version: 0.1.8
  • Generated with Connector SDK commit SHA: df1e8094b5b2d94e172536ce7f33fb98f2c3fdc1
  • Changelog: View changelog

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_agent_intercom-0.1.66.tar.gz (152.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airbyte_agent_intercom-0.1.66-py3-none-any.whl (176.4 kB view details)

Uploaded Python 3

File details

Details for the file airbyte_agent_intercom-0.1.66.tar.gz.

File metadata

  • Download URL: airbyte_agent_intercom-0.1.66.tar.gz
  • Upload date:
  • Size: 152.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for airbyte_agent_intercom-0.1.66.tar.gz
Algorithm Hash digest
SHA256 b5d51fedcb6b76cbb6186f05eec6e894c769e9af591e45304528c174b3198469
MD5 efba9a97cc5305090c7c7f9d4d4c0202
BLAKE2b-256 c1944414f7c40e3e405fd3407186f2d26bc3f59aa5cde0e54357b5ebae50a86e

See more details on using hashes here.

File details

Details for the file airbyte_agent_intercom-0.1.66-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_agent_intercom-0.1.66-py3-none-any.whl
Algorithm Hash digest
SHA256 a69972860e9d486e64898f5f4fac3607b1e9492d317e7defa85c2c5545c8d9b9
MD5 ae2e9390659a7a340acc1c89a97fe42b
BLAKE2b-256 caafbc6adab3508dfc4c9da83913aa10aebe11c9c75082545dc3cc69fd43be6c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page