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
  • Show me conversations from the last week
  • 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
  • Get details for contact {contact_id}
  • Show me all customer segments
  • Get company details for {company_id}
  • List conversations assigned to team {team_id}
  • Show me open conversations
  • Get conversation details for {conversation_id}

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

connector = IntercomConnector(
    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
Conversations List, Get
Companies List, Get
Teams List, Get
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.45
  • Connector version: 0.1.6
  • Generated with Connector SDK commit SHA: 580ea1221eff062f41b1065a155124c85861cb18
  • 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.45.tar.gz (143.5 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.45-py3-none-any.whl (166.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: airbyte_agent_intercom-0.1.45.tar.gz
  • Upload date:
  • Size: 143.5 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.45.tar.gz
Algorithm Hash digest
SHA256 795199996b29518221c0c4473824ddf1271117d66b6a6c0f48f3325aa7af65d2
MD5 ef1933e4ad96044c4c66e5c6ea9bd41a
BLAKE2b-256 e11508da7bec0a157942c6f1a22d54ea8196c91ca6b6d3ec132bfa1e060410bd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_intercom-0.1.45-py3-none-any.whl
Algorithm Hash digest
SHA256 745d67fb95a91da2df4a271bf35fbf362669e37a201604e08840c7c212c7d84e
MD5 6c673e147d0ec0d3755eb8ab7770b403
BLAKE2b-256 2c312e9e3e1bd924570db3602abf9bd69ee7db468e8fd1089f8bc018545b32ce

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