ridershow / intercom-postman-collection

A Postman Collection file for the Intercom API http://developers.intercom.com/reference Includes extraction code to generate the latest version

Intercom Postman Collection

• A Postman Collection file for the Intercom API
• Will allow you to make requests to the Intercom API
• Based on curl samples on http://developers.intercom.com/reference
• Compatible with Postman and Insomnia

Setup

1. Importing

• Use the intercom-postman-collection.json listed in the repository

Postman

• Import > Import File

Insomnia

• Main Menu > Import/Export > Import Data

2. Getting Access Token

• Get your Intercom Access Token from the Developer Hub

• Note: some API endpoints require an Extended Access Token
  • If you try to access these endpoints with a Standard Token you will get a Not authorized to access resource error (full error details shown below)
  • Ensure to apply for an extended access token

"errors": [
	{
		"code": "token_unauthorized",
		"message": "Not authorized to access resource"
	}
]

3. Configure your environment variables

• Create an AccessToken variable with the value of your access token obtained in the previous step

Postman

• Environment Options > Manage Environments > Add

Insomnia

• Environments dropdown > Manage Environments > +

Extracting the latest Postman collection

• Code for the extracting is in the extract folder
• It downloads the latest developer docs page and extracts out the curl commands and transforms them into the apporpriate
• Requirements: NodeJS and npm
• Usage

# change to directory with code
cd extract

# install dependencies
npm install

# run extractor to generate `intercom-postman-collection.json` file to be imported
node index.js