OAuth

You need to set up OAuth if you're building an integration that you intend to make publicly available (and therefore need access to other people's Intercom data). If you're just accessing your own data, you can use Personal Access Tokens instead.

🚧

Note: OAuth has replaced API Keys for public integrations

As of April 2017, all public integrations must use OAuth rather than API Keys.

For more information on the difference between OAuth and Access Tokens, please see our OAuth guide.

👍

Live OAuth Example Flow

We have a live OAuth example that may help explain the flow. You just need to have an Intercom account and you can check it out here

Applying for OAuth

We have implemented a version of the "Protocol" flow from the OAuth 2.0 specification. If you're thinking of building a connected app using OAuth, please look through the application process here to see how you can get developing immediately.

📘

Automatic OAuth approval

When you apply via your TEST Intercom app you will be automatically approved for OAuth so can get started working on your integration immediately. When you are ready you can then follow the steps here to apply for your main Intercom production app.