intercom-client

intercom-node

Official Node bindings to the Intercom API

Beta

This client library is in active development. Full API documentation can be found here.

Installation

npm install intercom-client

Testing

npm test

Running the code locally

Compile using babel:

gulp babel

Require Intercom:

var Intercom = require('./dist/index');

Usage

Require Intercom:

var Intercom = require('intercom-node');

Create a client:

var client = new Intercom.Client('app_id', 'app_api_key');

Users

// Create/update a user
client.users.create({ email: '[e-mail]' }, function (r) {
  console.log(r);
});

// List users
client.users.list(callback);

// List users by tag or segment
client.users.listBy({ tag_id: 'haven' }, callback);

// Find user by id
client.users.find({ id: '1234' }, callback);

// Delete user by id
client.users.delete({ id: '1234' }, callback);

Contacts

// Create a contact
client.contacts.create(function (r) {
  console.log(r);
});

// Update a contact by id
client.contacts.update({ id: '5435345', email: '[e-mail]' }, callback);

// List contacts
client.contacts.list(callback);

// List contacts by email
client.contacts.listBy({ email: '[e-mail]' }, callback);

// Find contact by id
client.contacts.find({ id: '5342423' }, callback);

// Delete contact by id
client.contacts.delete({ id: '5342423' }, callback);

// Convert Contacts into Users
var conversion = {
  contact: { user_id: '1234-5678-9876' },
  user: { email: '[e-mail]' }
};
client.contacts.convert(conversion, callback);

Companies

// Create/update a company
client.companies.create({ company_id: '1234', name: 'serenity' }, function (r) {
  console.log(r);
});

// List companies
client.companies.list(callback);

// List companies by tag or segment
client.companies.listBy({ tag_id: 'haven' }, callback);

// Find company by id
client.companies.find({ id: '1234' }, callback);

// List company users
client.companies.listUsers({ id: '1234' }, callback);

Events

// Create a event
client.events.create({
  event_name: 'Foo',
  created_at: 1439826340,
  user_id: 'bar'
}, function (d) {
  console.log(d);
});

Counts

client.counts.appCounts(callback);

client.counts.conversationCounts(callback);

client.counts.conversationAdminCounts(callback);

client.counts.userTagCounts(callback);

client.counts.userSegmentCounts(callback);

client.counts.companyTagCounts(callback);

client.counts.companySegmentCounts(callback);

client.counts.companyUserCounts(callback);

Admins

// List admins
client.admins.list(callback);

Tags

// Create a tag
client.tags.create({ name: 'haven' }, callback);

// Tag a user by id
client.tags.tag({ name: 'haven', users: [{ id: '54645654' }] }, callback);

// Tag a company by id
client.tags.tag({ name: 'haven', companies: [{ id: '54645654' }] }, callback);

// Untag a user by id
client.tags.untag({ name: 'haven', users: [{ id: '5345342' }] }, callback);

// List tags
client.tags.list(callback);

// Delete a tag by id
client.tags.delete({ id: '130963' }, callback);

Segments

// List segments
client.segments.list(callback);

// Find segment by id
client.segments.find({ id: '55719a4a' }, callback);

Bulk users

The Bulk APIs are themselves in Beta, but allow for the asynchronous creation and deletion of users:

client.users.bulk([
  { create: { email: '[e-mail]' }},
  { create: { email: '[e-mail]'}}
], callback);

Pagination

When listing, the Intercom API may return a pagination object:

{
  "pages": {
    "next": "..."
  }
}

You can grab the next page of results using the client:

client.nextPage(response.pages, callback);

License

Apache-2.0