intercom-ruby

Ruby bindings for the Intercom API (https://api.intercom.io).

API Documentation

Gem Documentation

For generating Intercom javascript script tags for Rails, please see https://github.com/intercom/intercom-rails

Upgrading information

Version 2 of intercom-ruby is not backwards compatible with previous versions. Be sure to test this new version before deploying to production. One other change you will need to make as part of the upgrade is to set Intercom.app_api_key and not set Intercom.api_key (you can continue to use your existing API key).

Additionally, the new version uses Ruby 2.

Installation

gem install intercom

Using bundler:

gem 'intercom', "~> 2.2.1"

Basic Usage

Configure your access credentials

Intercom.app_id="my_app_id"Intercom.app_api_key="my-super-crazy-api-key"

Resources

Resources this API supports:

https://api.intercom.io/users
https://api.intercom.io/companies
https://api.intercom.io/tags
https://api.intercom.io/notes
https://api.intercom.io/segments
https://api.intercom.io/events
https://api.intercom.io/conversations
https://api.intercom.io/messages
https://api.intercom.io/counts
https://api.intercom.io/subscriptions

Additionally, the library can handle incoming webhooks from Intercom and convert to Intercom:: models.

Examples

Users

# Find user by emailuser=Intercom::User.find(:email=>"bob@example.com")# Find user by user_iduser=Intercom::User.find(:user_id=>"1")# Find user by iduser=Intercom::User.find(:id=>"1")# Create a useruser=Intercom::User.create(:email=>"bob@example.com",:name=>"Bob Smith")# Update custom_attributes for a useruser.custom_attributes["average_monthly_spend"]=1234.56;user.save# Perform incrementinguser.increment('karma');user.save# Iterate over all usersIntercom::User.all.each{|user| puts%Q(#{user.email} - #{user.custom_attributes["average_monthly_spend"]})}Intercom::User.all.map{|user| user.email}

Admins

# Iterate over all adminsIntercom::Admin.all.each{|admin| putsadmin.email}

Companies

# Add a user to one or more companiesuser=Intercom::User.find(:email=>"bob@example.com")user.companies=[{:company_id=>6,:name=>"Intercom"},{:company_id=>9,:name=>"Test Company"}];user.save# You can also pass custom attributes within a company as you do thisuser.companies=[{:id=>6,:name=>"Intercom",:custom_attributes=>{:referral_source=>"Google"}}];user.save# Find a company by company_idcompany=Intercom::Company.find(:company_id=>"44")# Find a company by namecompany=Intercom::Company.find(:name=>"Some company")# Find a company by idcompany=Intercom::Company.find(:id=>"41e66f0313708347cb0000d0")# Update a companycompany.name='Updated company name';company.save# Iterate over all companiesIntercom::Company.all.each{|company| puts%Q(#{company.name} - #{company.custom_attributes["referral_source"]})}Intercom::Company.all.map{|company| company.name}# Get a list of users in a companycompany.users

Tags

# Tag userstag=Intercom::Tag.tag_users('blue',["42ea2f1b93891f6a99000427"])# Untag usersIntercom::Tag.untag_users('blue',["42ea2f1b93891f6a99000427"])# Iterate over all tagsIntercom::Tag.all.each{|tag| "#{tag.id} - #{tag.name}"}Intercom::Tag.all.map{|tag| tag.name}# Iterate over all tags for userIntercom::Tag.find_all_for_user(:id=>'53357ddc3c776629e0000029')Intercom::Tag.find_all_for_user(:email=>'declan+declan@intercom.io')Intercom::Tag.find_all_for_user(:user_id=>'3')# Tag companiestag=Intercom::Tag.tag_companies('red',["42ea2f1b93891f6a99000427"])# Untag companiesIntercom::Tag.untag_companies('blue',["42ea2f1b93891f6a99000427"])# Iterate over all tags for companyIntercom::Tag.find_all_for_company(:id=>'43357e2c3c77661e25000026')Intercom::Tag.find_all_for_company(:company_id=>'6')

Segments

# Find a segmentsegment=Intercom::Segment.find(:id=>segment_id)# Update a segmentsegment.name='Updated name';segment.save# Iterate over all segmentsIntercom::Segment.all.each{|segment| puts"id: #{segment.id} name: #{segment.name}"}

Notes

# Find a note by idnote=Intercom::Note.find(:id=>note)# Create a note for a usernote=Intercom::Note.create(:body=>"<p>Text for the note</p>",:email=>'joe@example.com')# Iterate over all notes for a user via their email addressIntercom::Note.find_all(:email=>'joe@example.com').each{|note| putsnote.body}# Iterate over all notes for a user via their user_idIntercom::Note.find_all(:user_id=>'123').each{|note| putsnote.body}

Conversations

# FINDING CONVERSATIONS FOR AN ADMIN# Iterate over all conversations (open and closed) assigned to an adminIntercom::Conversation.find_all(:type=>'admin',:id=>'7').eachdo{|convo| ... }# Iterate over all open conversations assigned to an adminIntercom::Conversation.find_all(:type=>'admin',:id=>7,:open=>true).eachdo{|convo| ... }# Iterate over closed conversations assigned to an adminIntercom::Conversation.find_all(:type=>'admin',:id=>7,:open=>false).eachdo{|convo| ... }# Iterate over closed conversations for assigned an admin, before a certain moment in timeIntercom::Conversation.find_all(:type=>'admin',:id=>7,:open=>false,:before=>1374844930).eachdo{|convo| ... }# FINDING CONVERSATIONS FOR A USER# Iterate over all conversations (read + unread, correct) with a user based on the users emailIntercom::Conversation.find_all(:email=>'joe@example.com',:type=>'user').eachdo{|convo| ... }# Iterate over through all conversations (read + unread) with a user based on the users emailIntercom::Conversation.find_all(:email=>'joe@example.com',:type=>'user',:unread=>false).eachdo{|convo| ... }# Iterate over all unread conversations with a user based on the users emailIntercom::Conversation.find_all(:email=>'joe@example.com',:type=>'user',:unread=>true).eachdo{|convo| ... }# FINDING A SINGLE CONVERSATIONconversation=Intercom::Conversation.find(:id=>'1')# INTERACTING WITH THE PARTS OF A CONVERSATION# Getting the subject of a part (only applies to email-based conversations)conversation.rendered_message.subject# Get the part_type of the first partconversation.conversation_parts[0].part_type# Get the body of the second partconversation.conversation_parts[1].body# REPLYING TO CONVERSATIONS# User (identified by email) replies with a commentconversation.reply(:type=>'user',:email=>'joe@example.com',:message_type=>'comment',:body=>'foo')# Admin (identified by email) replies with a commentconversation.reply(:type=>'admin',:email=>'bob@example.com',:message_type=>'comment',:body=>'bar')# MARKING A CONVERSATION AS READconversation.read=trueconversation.save

Counts

# Get Conversation per Adminconversation_counts_for_each_admin=Intercom::Count.conversation_counts_for_each_adminconversation_counts_for_each_admin.each{|count| puts"Admin: #{count.name} (id: #{count.id}) Open: #{count.open} Closed: #{count.closed}"}# Get User Tag Count ObjectIntercom::Count.user_counts_for_each_tag# Get User Segment Count ObjectIntercom::Count.user_counts_for_each_segment# Get Company Segment Count ObjectIntercom::Count.company_counts_for_each_segment# Get Company Tag Count ObjectIntercom::Count.company_counts_for_each_tag# Get Company User Count ObjectIntercom::Count.company_counts_for_each_user# Get total count of companies, users, segments or tags across appIntercom::Company.countIntercom::User.countIntercom::Segment.countIntercom::Tag.count

Full loading of an embedded entity

# Given a conversation with a partial user, load the full user. This can be# done for any entityconversation.user.load

Sending messages

# InApp message from admin to userIntercom::Message.create({:message_type=>'inapp',:body=>"What's up :)",:from=>{:type=>'admin',:id=>"1234"},:to=>{:type=>"user",:id=>"5678"}})# Email message from admin to userIntercom::Message.create({:message_type=>'email',:subject=>'Hey there',:body=>"What's up :)",:template=>"plain",# or "personal",:from=>{:type=>"admin",:id=>"1234"},:to=>{:type=>"user",:id=>"536e564f316c83104c000020"}})# Message from a userIntercom::Message.create({:from=>{:type=>"user",:id=>"536e564f316c83104c000020"},:body=>"halp"})

Events

Intercom::Event.create(:event_name=>"invited-friend",:created_at=>Time.now.to_i,:email=>user.email,:metadata=>{"invitee_email"=>"pi@example.org",:invite_code=>"ADDAFRIEND","found_date"=>12909364407})

Metadata Objects support a few simple types that Intercom can present on your behalf

Intercom::Event.create(:event_name=>"placed-order",:email=>current_user.email,:created_at=>1403001013,:metadata=>{:order_date=>Time.now.to_i,:stripe_invoice=>'inv_3434343434',:order_number=>{:value=>'3434-3434',:url=>'https://example.org/orders/3434-3434'},price: {:currency=>'usd',:amount=>2999}})

The metadata key values in the example are treated as follows-

• order_date: a Date (key ends with '_date').
• stripe_invoice: The identifier of the Stripe invoice (has a 'stripe_invoice' key)
• order_number: a Rich Link (value contains 'url' and 'value' keys)
• price: An Amount in US Dollars (value contains 'amount' and 'currency' keys)

Subscriptions

Subscribe to events in Intercom to receive webhooks.

# create a subscriptionIntercom::Subscription.create(:url=>"http://example.com",:topics=>["user.created"])# fetch a subscriptionIntercom::Subscription.find(:id=>"nsub_123456789")# list subscriptionsIntercom::Subscription.all

Webhooks

# create a payload from the notification hash (from json).payload=Intercom::Notification.new(notification_hash)payload.type# => 'user.created'payload.model_type# => Intercom::Useruser=payload.model# => Instance of Intercom::User

Note that models generated from webhook notifications might differ slightly from models directly acquired via the API. If this presents a problem, calling payload.load will load the model from the API using the id field.

Errors

You do not need to deal with the HTTP response from an API call directly. If there is an unsuccessful response then an error that is a subclass of Intercom:Error will be raised. If desired, you can get at the http_code of an Intercom::Error via it's http_code method.

The list of different error subclasses are listed below. As they all inherit off Intercom::Error you can choose to rescue Intercom::Error or else rescue the more specific error subclass.

Intercom::AuthenticationErrorIntercom::ServerErrorIntercom::ServiceUnavailableErrorIntercom::ResourceNotFoundIntercom::BadRequestErrorIntercom::RateLimitExceededIntercom::AttributeNotSetError# Raised when you try to call a getter that does not exist on an object