IntercomOAuth

Events

• NewLead

  New Lead

  This card monitors for new leads created in your Intercom account. NOTE: To read the custom attributes of the lead, use the action “Read Lead”.

  Output Fields

  • Lead
    • Intercom ID (string): the Intercom generated ID for the lead
    • User ID (text): the automatically generated identifier for the lead
    • Email (text): the email address of the lead
    • Name (text): the full name of the lead
    • Pseudonym (text): the fake name Intercom assigns to all leads before the real name of a lead is known. For example, “Grey Spaceship”
    • App ID (text): the ID of your Intercom application
    • Session Count (number): the number of sessions the user has on your website
    • Unsubscribed Fom Email? (boolean): returns true or false depending on whether or not the lead has unsubscribed from emails
    • Created At (text): the time that the lead was added to Intercom
    • Updated At (text): the time that the lead was last updated
    • Signed Up At (text): the time at which the user signed up or converted from a lead to a user. For New Lead this will be empty.
    • User Agent Data (text): data about the last user agent the lead was seen using
    • Last Requested At (text): the time that the lead last made a request
    • Last Seen IP (text): the IP address from which the lead last visited your application

Actions

• AddNotetoUser

  Add Note to User

  Add a note to a user in Intercom.

  Input Fields

  • Note
    • Content (text): the body of the note you are adding to the user.
    • User ID (text): the ID of the user to which you are adding the note. NOTE: You can find a user’s ID by using the action “Search User”.

  Ouptut Fields

  • Note
    • Note ID (text): a unique system-generated ID that identifies the note in Intercom.

• AddUsertoCompany

  Add User to Company

  Add a user to a company in Intercom.

  Input Fields

  • User
    • Intercom ID (text): the ID of the user you are adding to the company. This field is required. NOTE: You can find a user’s ID by using the action “Search User”.
  • Company
    • Company Intercom ID (text): the ID of the company to which you are adding a user. This field is required. NOTE: You can find a company’s ID by using the action “Search Company”.

• Convert Lead to User

  Convert an existing lead to a user using lead ID

• CreateCompany

  Create Company

  Create a new company in Intercom.

  Input Fields

  • Company
    • Name (text): the name of the company you are creating.
    • Plan (text): the name of the plan the company is subscribed to in your system.
    • Company ID (text): the ID of the company that you determine. NOTE: This is generally the ID of the company that is either within your internal system or to the ID of the company in your CRM. This is separate from the system-generated ID that Intercom will assign each company. This field is required.
    • Remote Created At (text): the time the company was created by you.
    • Monthly Spend (text): the monthly spend of the company for your service.
  • Custom Attributes
    • Click or drop into the space provided here to create a field that will define a custom attribute on the new company. NOTE: In order to write to existing custom fields within your Intercom application, type the field name to exactly match the existing attribute both in capitalization and spelling.

  Output Fields

  • Company
    • Intercom ID (text): a unique system-generated ID that identifies the company in Intercom.

• CreateLead

  Create Lead

  Create a new lead in your Intercom account. Leads are those contacts that have visited your website but have not yet signed up for your service.

  Input Fields

  • Lead
    • Email (text): the email address of the lead.
    • Name (text): the full name of the lead.
    • Last Requested At (timestamp): the time that the lead last made a request to your site. NOTE: This field must be displaying on your card in order for the lead to be created. You can simply leave the default value “0” in place.
    • Unsubscribed From Emails (dropdown): select ”true”if the lead has unsubscribed from emails or “false” if they have not. NOTE: False is the default.
    • Last Seen IP (text): the IP address from which the lead last visited your application.
  • Company
    • Intercom ID (string): theunique, system-generated ID of the company associated with the lead.
    • Company ID (text): the internal ID of the company that you defined when you created the company.
    • Name (text): the name of the company associated with the lead.
  • Custom Attributes
    • Click or drop into the space provided here to create a field that will define a custom attribute on the new lead. NOTE: In order to write to existing custom fields within your Intercom application, type the field name to exactly match the existing attribute both in capitalization and spelling.

  Output Fields

  • Lead
    • Intercom ID (string): the unique, system-generated ID for the lead

• CreateUser

  Create User

  Create a new user in your Intercom account. Users are those contacts that have signed up for your service. NOTE: If you would like to assign the user to a company when you create them, first use this action and then use the Add User to Company action.

  Input Fields

  • User
    • User ID (text): a unique identifier of the user that you define. This typically is the same ID the user has in your internal system or your CRM.
    • Email (text): the email address of the user. This field is required.
    • Name (text): the full name of the user.
    • Signed Up At (timestamp): the time at which the user signed up.
    • Last Seen IP (text): the IP address from which the user last visited your application
    • Unsubscribed From Emails (dropdown): select ”true”if the user has unsubscribed from emails or “false” if they have not. NOTE: False is the default.
  • Custom Attributes
    • Click or drop into the space provided here to create a field that will define a custom attribute on the new user. NOTE: In order to write to existing custom fields within your Intercom application, type the field name to exactly match the existing attribute both in capitalization and spelling.

  Output Fields

  • User
    • Intercom ID (string): the Intercom-generated ID for the user.

• DeleteLead

  Delete Lead

  Delete a lead in Intercom.

  Input Field

  • Lead
    • Intercom ID (text): the ID of the lead you are deleting. This field is required. NOTE: You can find a lead’s ID by using the action “Search Lead”.

• DeleteUser

  Delete User

  Delete a user in Intercom.

  Input Field

  • User
    • Intercom ID (text): the ID of the user you are deleting. This field is required. NOTE: You can find a user’s ID by using the action “Search User”.

• ReadCompany

  Read Company

  Read the information on an existing company in Intercom.

  Input Fields

  • Company
    • Intercom ID (text): the unique system-generated ID that identifies the company in Intercom. This field is required. NOTE: You can find this ID by using the “Search Company” action.

  Output Fields

  • Company
    • Company ID (text): the ID of the company that you determined upon creation of the company. NOTE: This is typically the ID of the company that is either within your internal system or to the ID of the company in your CRM. This is separate from the system-generated ID that Intercom will assign each company.
    • App ID (text): the ID of your Intercom application
    • Name (text): the name of the company.
    • Created At (timestamp): the time at which the company was created in Intercom.
    • Updated At (text):the time at which the company was last updated in Intercom.
    • Remote Created At (text): the time the company was created by you.
    • Last Requested At (timestamp): the last time a user associated with the company made a request to the service.
    • Monthly Spend (text): the monthly spend of the company for your service.
    • Session Count (number): the total number of sessions on your service of all the users associated with the company.
    • User Count (number): the total number of users associated with the company.
    • Tags (list): a list of tags associated with the company.
    • Segment IDs (list): a list of segments the company is within.
  • Plan
    • Plan ID (text): the id of the plan the company is subscribed to in your system.
    • Name (text): the name of the plan the company is subscribed to in your system.
  • Click or Drag to Create: Click or drop into the space provided here to create a field that will define a custom attribute on the new company. NOTE: In order to write to existing custom fields within your Intercom application, type the field name to exactly match the existing attribute both in capitalization and spelling.

• ReadLead

  Read Lead

  Read the information about an existing lead in Intercom.

  Input Field

  • Lead
    • Intercom ID (text): the unique system-generated ID that identifies the lead in Intercom. This field is required. NOTE: You can find this ID by using the “Search Lead” action.

  Output Fields

  • Lead
    • User ID (text): the ID of the lead that you determined upon creation of the lead. NOTE: This is typically the ID of the lead that is either within your internal system or to the ID of the lead in your CRM. This is separate from the system-generated ID that Intercom will assign each lead.
    • Email (text): the email address of the lead.
    • Name (text): the full name of the lead.
    • Pseudonym (text): the fake name Intercom assigns to all leads before the real name of a lead is known. For example, “Grey Spaceship”.
    • App ID (text): the ID of your Intercom application.
    • Session Count (number): the number of sessions the lead has on your website.
    • Unsubscribed From Emails (boolean): returns true or false depending on whether or not the lead has unsubscribed from emails.
    • Created At (timestamp): the time that the lead was added to Intercom.
    • Updated At (timestamp): the time that the lead was last updated.
    • Signed Up At (text): the time at which the lead signed up.
    • User Agent Data (text): data about the last user agent the lead was seen using.
    • Segment IDs (list): a list of segments (defined by ID) that the lead is within.
    • Tags (list): a list of tags associated with the lead.
    • Last Requested At (text): the time that the lead last made a request.
    • Last Seen IP (text): the IP address from which the lead last visited your application.
    • Companies (list of objects): a list of companies the lead is associated with.
    • Social Profiles (list of objects): a list of social profiles of the lead.
  • Click or Drag to Create: Click or drop into the space provided here to create a custom attribute field you can then read on the lead. NOTE: Make sure to exactly match the attribute both in capitalization and spelling as it exists in your Intercom application.

• ReadUser

  Read User

  Read the information about an existing user in Intercom.

  Input Field

  • User
    • Intercom ID (text): the unique system-generated ID that identifies the user in Intercom. This field is required. NOTE: You can find this ID by using the “Search User” action.

  Output Fields

  • User
    • User ID (text): the ID of the user that you determined upon creation of the user. NOTE: This is typically the ID of the user that is either within your internal system or to the ID of the contact in your CRM. This is separate from the system-generated ID that Intercom will assign each user.
    • Email (text): the email address of the user.
    • Name (text): the full name of the user.
    • Pseudonym (text): the fake name Intercom assigns to all leads before the real name of a lead is known. For example, “Grey Spaceship”.
    • App ID (text): the ID of your Intercom application.
    • Session Count (number): the number of sessions the user has in your application.
    • Unsubscribed From Emails (boolean): returns true or false depending on whether or not the user has unsubscribed from emails.
    • Created At (timestamp): the time that the user was added to Intercom.
    • Updated At (timestamp): the time that the user was last updated.
    • Signed Up At (text): the time at which the user signed up.
    • User Agent Data (text): data about the last agent the user was seen using.
    • Tags (list): a list of tags associated with the user.
    • Last Requested At (text): the time that the user last made a request.
    • Segment IDs (list): a list of segments (defined by ID) that the user is within.
    • Last Seen IP (text): the IP address from which the user last visited your application.
    • Companies (list of objects): a list of companies the user is associated with.
    • Social Profiles (list of objects): a list of social profiles of the user.
  • Location Data
    • City Name (text): the name of the city from which the user accesses your service.
    • Continent Code (text): the code of the continent from which the user accesses your service.
    • Country Name (text): the name of the country from which the user accesses your service.
    • Postal Code (text): the zip code from which the user accesses your service.
    • Region Name (text): the name of the region from which the user accesses your service.
    • Timezone (text): the timezone from which the user accesses your service.
    • Country Code (text): the code of the country from which the user accesses your service.

• RemoveUserfromCompany

  Remove User from Company

  Remove a user from a company in Intercom.

  Input Fields

  • User
    • Intercom ID (text): the ID of the user you are removing from the company. This field is required. NOTE: You can find a user’s ID by using the action “Search User”.
  • Company
    • Company Intercom ID (text): the ID of the company from which you are removing a user. This field is required. NOTE: You can find a company’s ID by using the action “Search Company”.

• SearchCompanies

  Search Companies

  Find a company’s Intercom ID by searching by either Company Name or Company ID.

  Input Fields

  Only one input is required.

  • Company
    • Company Name (text): the name of the company. Will only find exact matches.
    • Company ID (text): the ID of the company that you determined upon creation of the company. NOTE: This is typically the ID of the company that is either within your internal system or to the ID of the company in your CRM. This is separate from the system-generated ID that Intercom will assign each company.

  Output Fields

  •  Company
    • Intercom ID (text): the unique system-generated ID of the company in Intercom, or null string if none found.

• SearchLeads

  Search Leads

  Find a lead’s Intercom ID by searching by email.

  Input Field

  • Lead
    • Email (text): the email of the lead you are searching for.

  Output Field

  •  Lead
    • Intercom ID (text): the unique system-generated ID of the lead in Intercom.

• SearchUsers

  Search Users

  Find a user’s Intercom ID by searching by email.

  Input Field

  • User
    • Email (text): the email of the user you are searching for.

  Output Field

  •  User
    • Intercom ID (text): the unique system-generated ID of the user in Intercom.

• TagCompany

  Tag Company

  Add a single tag to a company in Intercom.

  Input Fields

  • Tag
    • Name (text): the name of the tag. If you have pre-defined tags within your Intercom account, you can add those tags to the company by exactly matching the spelling and case.
  •  Company
    • Intercom ID (text): the unique system-generated ID of the company in Intercom.

  Output Field

  • Tag
    • ID (text): the unique, system-generated ID of the tag that was added to the company.

• TagUser

  Tag User

  Add a single tag to a user in Intercom.

  Input Fields

  • Tag
    • Name (text): the name of the tag. If you have pre-defined tags within your Intercom account, you can add those tags to the user by exactly matching the spelling and case.
  •  User
    • Intercom ID (text): the unique, system-generated ID of the user in Intercom.

  Output Field

  • Tag
    • ID (text): the unique, system-generated ID of the tag that was added to the user.

• UpdateCompany

  Update Company

  Update an existing company in Intercom.

  Input Fields

  • Update By
    • Intercom ID (text): a unique, system-generated ID that identifies the company in Intercom. This field is required.
  • Company
    • Name (text): the name of the company.
    • Plan (text): the name of the plan the company is subscribed to in your system.
    • Company ID (text): the ID of the company that you define. NOTE: This is generally the ID of the company that is either within your internal system or to the ID of the company in your CRM. This is separate from the system-generated ID that Intercom will assign each company.
    • Remote Created At (text): the time the company was created by you.
    • Monthly Spend (text): the monthly spend of the company.
  • Custom Attributes
    • Click or drop into the space provided here to create a field that will define a custom attribute on the company. NOTE: In order to write to existing custom fields within your Intercom application, type the field name to exactly match the existing attribute both in capitalization and spelling.

• UpdateLead

  Update Lead

  Update an existing lead in your Intercom account. Leads are those contacts that have visited your website but have not yet signed up for your service.

  Input Fields

  • Update By
    • Intercom ID (string): the unique, system-generated ID for the lead. This field is required. NOTE: You can find the lead’s Intercom ID by using the “Search Lead” action.
  • Lead
    • User ID (text): a unique identifier of the user that you define. This typically is the same ID the user has in your internal system or your CRM.
    • Email (text): the email address of the lead.
    • Name (text): the full name of the lead.
    • Unsubscribed From Emails (dropdown): select ”true”if the lead has unsubscribed from emails or “false” if they have not. NOTE: False is the default.
    • Last Seen IP (text): the IP address from which the lead last visited your application.
  • Company
    • Intercom ID (string): the unique, system-generated ID of the company associated with the lead.
    • Company ID (text): the internal ID of the company that you defined when you created the company.
    • Name (text): the name of the company associated with the lead.
  • Custom Attributes
    • Click or drop into the space provided here to create a field that will define a custom attribute on the lead. NOTE: In order to write to existing custom fields within your Intercom application, type the field name to exactly match the existing attribute both in capitalization and spelling.

• UpdateUser

  Update User

  Update an existing user in your Intercom account. Users are contacts that have signed up for your service.

  Input Fields

  • Update By
    • Intercom ID (string): the unique, system-generated ID for the user. NOTE: You can find a user’s Intercom ID by using the “Search User” action.
  • User
    • User ID (text): a unique identifier of the user that you define. This typically is the same ID the user has in your internal system or your CRM.
    • Email (text): the email address of the user.
    • Name (text): the full name of the user.
    • Signed Up At (timestamp): the time at which the user signed up.
    • Last Seen IP (text): the IP address from which the user last visited your application
    • Unsubscribed From Emails (dropdown): select ”true”if the user has unsubscribed from emails or “false” if they have not. NOTE: False is the default.
  • Company
    • Intercom ID (text): the unique, system-generated ID for the company associated with the user. NOTE: You can find a company’s Intercom ID by using the “Search Company” action.
    • Company ID (text): a unique identifier of the company that you define. This typically is the same ID the user has in your internal system or your CRM.
    • Name (text): the name of the company associated with the user.
  • Custom Attributes
    • Click or drop into the space provided here to create a field that will define a custom attribute on the user. NOTE: In order to write to existing custom fields within your Intercom application, type the field name to exactly match the existing attribute both in capitalization and spelling.

• ConvertLead

  Convert Lead

  Convert a lead to a user within Intercom. This usually happens automatically when a user signs up for your service, but you can use this action to convert a lead manually.

  Input Field

  • Lead
    • Intercom ID (text): the ID of the lead you are converting to a user. This field is required. NOTE: You can find a lead’s ID by using the action “Search Lead”.

• SubmitEvent

  Submit Event

  Add a user’s behavior on your app to their Intercom profile by submitting an event for every behavior they take in the platform.

  Input Fields

  • Event
    • Name (text): the name of the event. If you have pre-defined events within your Intercom account, you can increment the count of that event by 1 on the user’s profile by exactly matching the name of the existing event.
    • Created At (timestamp): the time at which the event was added to the user’s profile in Intercom.
    • User ID (text): the ID you defined for the user to which you want to add the event . NOTE: Not all users will have a User ID. We recommend using Email instead as every user in Intercom will have an email address to identify them.
    • Email (text): the email of the user to which you want to add the event.
  •  metadata
    • Click or drop here to create: type in a field name or drag a field into this area in order to define the metadata for the event you are adding to the user’s profile. Note: Adding metadata to an event is optional.