You'll need to set up an Intercom account in order to get started. If you have your own workspace already and want to use that for development, then login through the usual page here.
Alternatively, we highly recommend that you create a new developer workspace for developing apps. developer workspaces are totally free and intended for development purposes only.
Developer Workspace Limitations
These free workspaces we provide you will not have all the functionalities of a standard Intercom production workspace. These limitations include:
- No outbound emailing or push notifications.
- Help Center Sites that can never be set live.
- A watermarked Messenger, showing that it's linked to a Developer Workspace.
- A maximum of 20 users/leads (if you have more than 20 users/leads, the oldest extras will be archived automatically on a regular basis).
Now that you have your workspace, it's time to create your first app in the Developer Hub.
Everything is an app
Anytime you want to interact with the Intercom Platform–via the REST API, webhooks, or to build an app for the Messenger–you start by creating an app. Apps are like containers for the various functionality that you have access to on the Intercom Platform and each app can be managed and installed to your other Intercom workspaces independently.
- In Your Apps, click New App.
- In the modal box, put the name of your app and select the workspace you want to install it on.
- Click Create app. This will create the app and pre-install it to your selected workspace.
On the Your Workspaces page, you can manage where your app is installed, and view your Access Token for each workspace.
You can also view your Access Token on the Authentication page, which provides greater details alongside OAuth settings.
Access Tokens or OAuth
An Access Token is used to access your own workspace data via the API. You should never give your Access Token to a 3rd party. If you're building an app that's destined to be used only by your own teams in your own workspaces then using your Access Token is generally sufficient.
However, if you plan to make your app publicly available on the Intercom App Store you'll need to set up OAuth. But don't worry, you can always decide to set up OAuth at a later date. For more information on authorization and setting up OAuth take a look at the guide here.
Test out your app's Access Token by making a call to our API, or build a functional app in the Messenger within 30 minutes.
|Make an API call|
|Build an app for your Messenger|
|Build an app for your Inbox|
|Setting up Webhooks|