SAP Open Connectors

Intercom Authenticate a Connector Instance

You can authenticate with Intercom to create your own instance of the Intercom connector through the UI or through APIs. Once authenticated, you can use the connector instance to access the different functionality offered by the Intercom platform.

Authenticate Through the UI

Use the UI to authenticate with Intercom and create a connector instance. Because you authenticate with Intercom via OAuth 2.0, you need to add a name for the instance, the API key and API secret as they are mandatory fields. After you create the instance, you'll log in to Intercom to authorize SAP Open Connectors access to your account. For more information about authenticating a connector instance, see Authenticate a Connector Instance (UI)

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a common resource, or use it in a formula template.

Authenticate Through API

Authenticating through API is a multi-step process that involves:


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


Getting a Redirect URL


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


Use the following API call to request a redirect URL where the user can authenticate with the vendor. Replace {keyOrId} with the connector key, intercom.

GET /elements/{keyOrId}/oauth/url?apiKey=<api_key>&apiSecret=<api_secret>&callbackUrl=<url>&siteAddress=<url>

Query Parameters

Query ParameterDescription
apiKeyThe key obtained from registering your app with the provider. This is the App key that you recorded in API Provider Setup.
apiSecretThe client secret obtained from registering your app with the provider. This is the App secret that you recorded in API Provider Setup.
callbackUrlThe URL that will receive the code from the vendor to be used to create a connector instance. This is https://auth.cloudelements.io/oauth, the redirect URL you added to your Intercom app during API Provider Setup.

Example cURL

curl -X GET
-H 'Content-Type: application/json'
'https://api.openconnectors.us2.ext.hana.ondemand.com/elements/api-v2/elements/intercom/oauth/url?apiKey=<INSERT_API_KEY>&apiSecret=fake_api_secret&callbackUrl=https://auth.cloudelements.io/oauth&state=intercom'

Example Response

Use the oauthUrl in the response to allow users to authenticate with the vendor.

{
"oauthUrl": "https://app.intercom.io/oauth?scope=read&response_type=code&redirect_uri=https%3A%2F%2Fauth.cloudelements.io%2Foauth&state=intercom&client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"element": "intercom"
}

Authenticating users and receiving the authorization grant code


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


Provide the response from the previous step to the users. After they authenticate, Intercom provides the following information in the response:

  • code
  • state
Response ParameterDescription
codeThe Authorization Grant Code required by SAP Open Connectors to retrieve the OAuth access and refresh tokens from the endpoint.
stateA customizable identifier, typically the connector key (intercom) .
Note: If the user denies authentication and/or authorization, there will be a query string parameter called error instead of the code parameter. In this case, your application can handle the error gracefully.

Authenticating the Connector Instance


1
Redirect URL




2
Authenticate Users




3
Authenticate Instance


Use the /instances endpoint to authenticate with Intercom and create a connector instance. If you are configuring events, see Intercom Events (coming soon).

Note: The endpoint returns a connector id and token upon successful completion. Retain the token and id for all subsequent requests involving this connector instance.

To create a connector instance:

  1. Construct a JSON body as shown below (see Parameters):

            {
              "element": {
                "key": "intercom"
              },
              "providerData": {
                "code": "<AUTHORIZATION_GRANT_CODE>"
              },
              "configuration": {
                "oauth.api.key": "<CLIENT_ID>",
                "oauth.api.secret": "<CLIENT_SECRET>",
                "oauth.callback.url": "https://www.mycoolapp.com/auth"
              },
              "tags": [
                "<ADD_YOUR_TAGS>"
              ],
              "name": "<INSTANCE_NAME>"
            }
    
  2. Call the following, including the JSON body you constructed in the previous step:

    POST /instances
    
    Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.
  3. Note the Token and ID and save them for all future requests using the connector instance.

Example cURL

curl -X POST \
  https://api.openconnectors.us2.ext.hana.ondemand.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
    "element": {
      "key": "intercom"
    },
    "providerData": {
      "code": "8aa74ff8ae16ba3ca19d12cbdea83aff16bddcd7"
    },
    "configuration": {
      "oauth.api.key": "xxxxxxxxxxxxxxxxxx",
      "oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxx",
      "oauth.callback.url": "https://mycoolapp.com/auth"
    },
    "tags": [
      "Test"
    ],
    "name": "API Instance"
  }'

Parameters

API parameters not shown in SAP Open Connectors are in code formatting.

Note: Event related parameters are described in Events (documentation coming soon).
ParameterDescriptionData Type
'key'The connector key.
intercom
string
Name
name
The name for the connector instance created during authentication.Body
oauth.callback.urlThe Callback URL for the connected app you created for Intercom. This is the Redirect URI that you recorded in API Provider Setup.
oauth.api.keyThe key obtained from registering your app with the provider. This is the App key that you recorded in API Provider Setup.string
oauth.api.secretThe client secret obtained from registering your app with the provider. This is the App secret that you recorded in API Provider Setup.string
tagsOptional. User-defined tags to further identify the instance.string

Example Response for an Authenticated Connector Instance

{
  "id": 594927,
  "name": "myCoolInstance",
  "createdDate": "2019-07-12T15:29:52Z",
  "token": "cTLkRO4XI7zfa650jn/sdZU8apLZFZLe43r6pub+jIA=",
  "element": {
    "id": 7549,
    "name": "Intercom",
    "key": "intercom",
    "description": "Intercom’s platform lets businesses track and filter customer data. This data includes conversation history, product usage behaviour, past purchases, payment details, etc. Businesses can use these attributes to trigger personalised, automated marketing emails and in-app messages",
    "image": "elements/provider_intercom.png",
    "logo": "intercom",
    "active": true,
    "deleted": false,
    "typeOauth": false,
    "trialAccount": false,
    "resources": [ ],
    "objects": [ ],
    "transformationsEnabled": true,
    "bulkDownloadEnabled": false,
    "bulkUploadEnabled": false,
    "cloneable": true,
    "extendable": true,
    "beta": false,
    "authentication": {
      "type": "oauth2"
    },
    "extended": false,
    "useModelsForMetadata": true,
    "hub": "marketing",
    "protocolType": "http",
    "parameters": [ ],
    "private": false
  },
  "user": {
    "id": 184978
  }
}