intercom-hello-world

name	intercom-hello-world
description	Create a minimal working Intercom example with contacts, conversations, and messages. Use when starting a new Intercom integration, testing your setup, or learning the core Intercom API data model. Trigger with phrases like "intercom hello world", "intercom example", "intercom quick start", "simple intercom code", "first intercom API call".
allowed-tools	Read, Write, Edit
version	1.6.0
license	MIT
author	Jeremy Longshore <[e-mail]>
tags	["saas","support","messaging","intercom"]
compatibility	Designed for Claude Code

Intercom Hello World

Overview

Minimal working examples covering the Intercom core data model: contacts (users and leads), conversations, messages, and tags. This skill gives you the first end-to-end round trip against the Intercom REST API — create a contact, search it, message it, open a conversation, and tag it — so you can confirm your credentials work and internalize how the entities relate before building anything real.

Prerequisites

Before running any snippet below, make sure the following are in place. Each is verified once during the intercom-install-auth setup step:

• Completed the intercom-install-auth setup (installs the SDK and stores your token).
• The intercom-client npm package installed in your project (npm install intercom-client).
• A valid Intercom access token exported as INTERCOM_ACCESS_TOKEN in your environment. The SDK reads this token to authenticate every request; there is no separate login call.

Instructions

The workflow is five short steps against the core data model. The first — creating a contact — is shown in full here so you can run immediately. Steps 2 through 5 (search, message, conversation, tag) follow the identical client.<resource>.<verb>(...) shape and live in the walkthrough reference.

Step 1: Create a Contact

Contacts are the core entity. They have a role of either user (identified) or lead (anonymous).

import { IntercomClient } from "intercom-client";

const client = new IntercomClient({
  token: process.env.INTERCOM_ACCESS_TOKEN!,
});

// Create a user contact
const user = await client.contacts.create({
  role: "user",
  externalId: "user-12345",
  email: ,
  : ,
});

.();