Skip to main content

Intercom Component

Intercom

Manage companies, contacts and tags on the Intercom platform

Component key: intercom

Description​

Intercom is a tool purpose-built for sales, marketing, and support to use together.

Connections​

Intercom​

To connect to Intercom you will need to create a new app in their Developer Hub.

Click "New App" and select "Public app" (you can use "Internal integration" if you do not need to connect to customer Intercom workspaces).

To enable OAuth you need to navigate to "Authentication", click the "Edit" button, and check "Use OAuth". Click "Add redirect URL" and enter Prismatic's callback URL: https://oauth2.prismatic.io/callback

You can also use this opportunity to reduce the selected Permissions (scopes) if desired. Once complete, click "Save".

Next, collect the Client ID and Client secret from the "Basic information" page.

You are now ready to create the OAuth 2.0 connection to Intercom within Prismatic:

  • Enter the Client ID and Client secret values into the same named fields.

Save your integration and you should now be able to authenticate to Intercom.

Note that you will need to submit your Intercom app for review when it is ready for production.

Actions​

Archive Contact​

Archive an existing Contact | key: archiveContact

Output Example Payload​

{
  "data": {
    "id": "5ba682d23d7cf92bef87bfd4",
    "object": "contact",
    "archived": true
  }
}

Attach Company to Contact​

Attach Company to Contact | key: attachCompany

Attach Tag to Contact​

Attach a Tag to a Contact | key: attachTag

Create Company​

Create a new Company | key: createCompany

Output Example Payload​

{
  "data": {
    "type": "company",
    "id": "531ee472cce572a6ec000006",
    "name": "Blue Sun",
    "plan": "plan1",
    "company_id": "6",
    "remote_created_at": 1394531169,
    "created_at": 1394533506,
    "updated_at": 1396874658,
    "size": 85,
    "website": "http://www.example.com",
    "industry": "Manufacturing",
    "monthly_spend": 49,
    "session_count": 26,
    "user_count": 10,
    "custom_attributes": {
      "paid_subscriber": true,
      "team_mates": 0
    }
  }
}

Create Contact​

Create a new Contact | key: createContact

Output Example Payload​

{
  "data": {
    "type": "contact",
    "id": "5ba682d23d7cf92bef87bfd4",
    "workspace_id": "ecahpwf5",
    "external_id": "25",
    "role": "user",
    "email": "wash@serenity.io",
    "phone": "+1123456789",
    "name": "Hoban Washburn",
    "avatar": "https://example.org/128Wash.jpg",
    "owner_id": 127,
    "social_profiles": {
      "type": "list",
      "data": [
        {
          "type": "social_profile",
          "name": "Twitter",
          "url": "http://twitter.com/th1sland"
        }
      ]
    },
    "unsubscribed_from_emails": false,
    "created_at": 1571672154,
    "updated_at": 1571672158,
    "signed_up_at": 1571069751,
    "last_seen_at": 1571069751,
    "last_replied_at": 1571672158,
    "last_contacted_at": 1571672158,
    "last_email_opened_at": 1571673478,
    "last_email_clicked_at": 1571676789,
    "language_override": null,
    "browser": "chrome",
    "browser_version": "77.0.3865.90",
    "browser_language": "en",
    "os": "OS X 10.14.6",
    "location": {
      "type": "location",
      "country": "Ireland",
      "region": "Dublin",
      "city": "Dublin"
    },
    "android_app_name": null,
    "android_app_version": null,
    "android_device": null,
    "android_os_version": null,
    "android_sdk_version": null,
    "android_last_seen_at": null,
    "ios_app_name": null,
    "ios_app_version": null,
    "ios_device": null,
    "ios_os_version": null,
    "ios_sdk_version": null,
    "ios_last_seen_at": null,
    "custom_attributes": {
      "paid_subscriber": true,
      "monthly_spend": 155.5,
      "team_mates": 1
    },
    "tags": {
      "type": "list",
      "data": [
        {
          "type": "tag",
          "id": "2",
          "url": "/tags/2"
        },
        {
          "type": "tag",
          "id": "4",
          "url": "/tags/4"
        },
        {
          "type": "tag",
          "id": "5",
          "url": "/tags/5"
        }
      ],
      "url": "/contacts/5ba682d23d7cf92bef87bfd4/tags"
    },
    "notes": {
      "type": "list",
      "data": [
        {
          "type": "note",
          "id": "20114858",
          "url": "/notes/20114858"
        }
      ],
      "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
    },
    "companies": {
      "type": "list",
      "data": [
        {
          "type": "company",
          "id": "5ba686093d7cf93552a3dc99",
          "url": "/companies/5ba686093d7cf93552a3dc99"
        },
        {
          "type": "company",
          "id": "5cee64a03d7cf90c51b36f19",
          "url": "/companies/5cee64a03d7cf90c51b36f19"
        },
        {
          "type": "company",
          "id": "5d7668883d7cf944dbc5c791",
          "url": "/companies/5d7668883d7cf944dbc5c791"
        }
      ],
      "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies"
    }
  }
}

Create Tag​

Create a new Tag | key: createTag

Output Example Payload​

{
  "data": {
    "id": "17513",
    "name": "independent",
    "type": "tag"
  }
}

Delete Company​

Delete an existing Company | key: deleteCompany

Output Example Payload​

{
  "data": {
    "id": "5ba682d23d7cf92bef87bfd4",
    "object": "company",
    "deleted": "true"
  }
}

Delete Contact​

Delete an existing Contact | key: deleteContact

Output Example Payload​

{
  "data": {
    "id": "5ba682d23d7cf92bef87bfd4",
    "object": "contact",
    "deleted": true
  }
}

Delete Tag​

Delete an existing Tag | key: deleteTag

Output Example Payload​

{
  "data": {
    "id": "17513",
    "name": "independent",
    "type": "tag"
  }
}

Detach Company from Contact​

Detach Company from Contact | key: detachCompany

Detach Tag from Contact​

Detach a Tag from a Contact | key: detachTag

List Companies​

Page through all Companies | key: listCompanies

List Tags​

List all Tags | key: listTags

Output Example Payload​

{
  "data": [
    {
      "id": "17513",
      "name": "independent",
      "type": "tag"
    }
  ]
}

Raw Request​

Issue a raw HTTP request to the Intercom API | key: rawRequest

Search Contacts​

Search through all Contacts | key: searchContacts

Unarchive Contact​

Unarchive an archived Contact | key: unarchiveContact

Output Example Payload​

{
  "data": {
    "id": "5ba682d23d7cf92bef87bfd4",
    "object": "contact",
    "archived": false
  }
}

Update Company​

Update an existing Company | key: updateCompany

Output Example Payload​

{
  "data": {
    "type": "company",
    "id": "531ee472cce572a6ec000006",
    "name": "Blue Sun",
    "plan": "plan1",
    "company_id": "6",
    "remote_created_at": 1394531169,
    "created_at": 1394533506,
    "updated_at": 1396874658,
    "size": 85,
    "website": "http://www.example.com",
    "industry": "Manufacturing",
    "monthly_spend": 49,
    "session_count": 26,
    "user_count": 10,
    "custom_attributes": {
      "paid_subscriber": true,
      "team_mates": 0
    }
  }
}

Update Contact​

Update an existing Contact | key: updateContact

Output Example Payload​

{
  "data": {
    "type": "contact",
    "id": "5ba682d23d7cf92bef87bfd4",
    "workspace_id": "ecahpwf5",
    "external_id": "25",
    "role": "user",
    "email": "wash@serenity.io",
    "phone": "+1123456789",
    "name": "Hoban Washburn",
    "avatar": "https://example.org/128Wash.jpg",
    "owner_id": 127,
    "social_profiles": {
      "type": "list",
      "data": [
        {
          "type": "social_profile",
          "name": "Twitter",
          "url": "http://twitter.com/th1sland"
        }
      ]
    },
    "unsubscribed_from_emails": false,
    "created_at": 1571672154,
    "updated_at": 1571672158,
    "signed_up_at": 1571069751,
    "last_seen_at": 1571069751,
    "last_replied_at": 1571672158,
    "last_contacted_at": 1571672158,
    "last_email_opened_at": 1571673478,
    "last_email_clicked_at": 1571676789,
    "language_override": null,
    "browser": "chrome",
    "browser_version": "77.0.3865.90",
    "browser_language": "en",
    "os": "OS X 10.14.6",
    "location": {
      "type": "location",
      "country": "Ireland",
      "region": "Dublin",
      "city": "Dublin"
    },
    "android_app_name": null,
    "android_app_version": null,
    "android_device": null,
    "android_os_version": null,
    "android_sdk_version": null,
    "android_last_seen_at": null,
    "ios_app_name": null,
    "ios_app_version": null,
    "ios_device": null,
    "ios_os_version": null,
    "ios_sdk_version": null,
    "ios_last_seen_at": null,
    "custom_attributes": {
      "paid_subscriber": true,
      "monthly_spend": 155.5,
      "team_mates": 1
    },
    "tags": {
      "type": "list",
      "data": [
        {
          "type": "tag",
          "id": "2",
          "url": "/tags/2"
        },
        {
          "type": "tag",
          "id": "4",
          "url": "/tags/4"
        },
        {
          "type": "tag",
          "id": "5",
          "url": "/tags/5"
        }
      ],
      "url": "/contacts/5ba682d23d7cf92bef87bfd4/tags"
    },
    "notes": {
      "type": "list",
      "data": [
        {
          "type": "note",
          "id": "20114858",
          "url": "/notes/20114858"
        }
      ],
      "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
    },
    "companies": {
      "type": "list",
      "data": [
        {
          "type": "company",
          "id": "5ba686093d7cf93552a3dc99",
          "url": "/companies/5ba686093d7cf93552a3dc99"
        },
        {
          "type": "company",
          "id": "5cee64a03d7cf90c51b36f19",
          "url": "/companies/5cee64a03d7cf90c51b36f19"
        },
        {
          "type": "company",
          "id": "5d7668883d7cf944dbc5c791",
          "url": "/companies/5d7668883d7cf944dbc5c791"
        }
      ],
      "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies"
    }
  }
}

Update Tag​

Update an existing Tag | key: updateTag

Output Example Payload​

{
  "data": {
    "id": "17513",
    "name": "independent",
    "type": "tag"
  }
}