Intercom icon

Intercom

Consume Intercom API

Actions10

Overview

The Intercom node's "Contact → Create" operation allows you to create a new contact (user or lead) in your Intercom workspace. This is useful for automating the addition of users from other systems, signup forms, or marketing tools into Intercom for customer engagement, support, or segmentation.

Common scenarios:

  • Automatically adding new signups as contacts in Intercom.
  • Syncing user data from another CRM or database.
  • Enriching contacts with custom attributes and company associations.

Example:
When a new user registers on your website, use this node to create a corresponding contact in Intercom, including their email, name, and any relevant metadata.


Properties

Name Type Meaning
Identifier Type options Specifies whether to identify the contact by Email or External ID.
Value string The actual value for the identifier (email address or external ID). Required.
JSON Parameters boolean If true, allows entering custom attributes as raw JSON; otherwise, use UI fields.
Additional Fields collection Optional extra fields to set on the contact (e.g., avatar, companies, phone, UTM parameters, etc.).
└ Avatar string URL to an HTTPS image to use as the contact's avatar.
└ Company Names or IDs multiOptions List of companies (by name or ID) to associate with the contact.
└ Name string Name of the contact.
└ Phone string Contact's phone number.
└ Session Count number Number of sessions recorded for the contact.
└ Unsubscribed From Emails boolean Whether the contact is unsubscribed from emails.
└ Update Last Request At boolean If true, updates the contact's last_request_at timestamp to now.
└ UTM Campaign string UTM campaign parameter for tracking.
└ UTM Content string UTM content parameter for tracking.
└ UTM Medium string UTM medium parameter for tracking.
└ UTM Source string UTM source parameter for tracking.
└ UTM Term string UTM term parameter for tracking.
Custom Attributes (JSON) json Key/value pairs for custom data (if JSON Parameters is true).
Custom Attributes (UI) fixedCollection Key/value pairs for custom data (if JSON Parameters is false).

Output

The node returns the created contact object as received from the Intercom API. The structure typically includes:

{
  "type": "contact",
  "id": "123456789",
  "workspace_id": "abcdefg",
  "external_id": "optional-external-id",
  "email": "user@example.com",
  "name": "User Name",
  "avatar": { "type": "avatar", "image_url": "https://..." },
  "phone": "1234567890",
  "unsubscribed_from_emails": false,
  "session_count": 1,
  "custom_attributes": {
    "key1": "value1",
    "key2": "value2"
  },
  "companies": [
    { "company_id": "987654321", ... }
  ],
  "utm_source": "...",
  "utm_medium": "...",
  "utm_campaign": "...",
  "utm_term": "...",
  "utm_content": "...",
  ...
}
  • All fields are returned as provided by Intercom.
  • If there is an error and "Continue On Fail" is enabled, the output will include an error field with the error message.

Dependencies

  • External Service: Requires access to the Intercom API.
  • API Credentials: You must configure Intercom API credentials (intercomCredentialsApi) in n8n.
  • Environment: No special environment variables required beyond n8n credential setup.

Troubleshooting

Common Issues:

  • Missing Required Fields: If "Value" (email or external ID) is not provided, the node will throw an error.
  • Invalid Email/ID: If the identifier is invalid or already exists, Intercom may reject the request.
  • Authentication Errors: If credentials are missing or incorrect, you'll receive an authentication error.
  • Invalid Custom Attributes JSON: If using JSON input for custom attributes, malformed JSON will cause validation errors.

Error Messages:

  • "Intercom Error: ...": Indicates an error response from the Intercom API. Check the error details for more information.
  • "Cannot parse JSON parameter": Means the custom attributes JSON is invalid. Ensure it is properly formatted.

How to resolve:

  • Double-check all required fields.
  • Validate email addresses and external IDs.
  • Ensure your Intercom credentials are correct and have sufficient permissions.
  • Use a JSON validator when entering custom attributes as JSON.

Links and References

Discussion