Javascript API: Attributes & Objects

This page details the possible attributes that can be used when Installing the Messenger

window.intercomSettings = { 
  app_id: YOUR_WORKSPACE_ID
  // customise installation with your attributes 
}

These attributes will modify the behaviour of the messenger. They do not modify user/lead data.

* The color string can be any valid CSS Color Name HEX or RGB

These attributes are used to update user/lead information.

• When user_id / email is provided, it will be saved as a User record
• When no user_id / email is provided, it will be considered a Visitor record which is not seen in the Intercom dashboard. When a Visitor sends a message via the Intercom messenger they will be converted to a Lead which is viewable in the Intercom dashboard
• Any other attribute not listed below and not in the Messenger Attributes will be treated as a custom user attribute
• If the value of a custom user attribute is set to an empty string, or a string with the value "undefined", or "null", this will appear as Unknown in Platform.
• If a value is set for a custom user attribute that has been configured to prevent updates via the Messenger then this value will be ignored in the request.

[]

Similar to the API avatar object

window.intercomSettings =  {
  app_id: YOUR_WORKSPACE_ID, 
  user_id: USER_ID_OF_CURRENTLY_LOGGED_IN_USER, 
  avatar: {
    "type": "avatar", 
    "image_url" :"https://yourwebsite.com/user_id/profile.png"
  }
 }

Learn more about companies from our Help Center article.
These are very similar to the API company object.
Attributes not listed below will be considered as a custom company attribute.
Note: Company ID and company name are the minimum requirements to pass a company into Intercom.

window.intercomSettings = {
  app_id: YOUR_WORKSPACE_ID, 
  user_id: USER_ID_OF_CURRENTLY_LOGGED_IN_USER, 
  company: {
    company_id: "6",
    created_at: 1394531169,
    name: "Example Company Inc.",
    monthly_spend: 49,
    plan: "Pro",
    size: 85,
    website: "http://example.com",
    industry: "Technology"
  }
}

[]