Skip to content
Home/
REST API Reference
/
/
OAuth Configuration

OAuth Configuration

The OAuth client-credentials configuration Intercom uses to obtain and refresh an access token. Required when token_type is oauth. Must be omitted when token_type is text.

token_urlstringrequired

The token endpoint Intercom exchanges the client credentials with. Must be an https URL.

Example:"https://auth.fulfilment.example.com/oauth/token"
client_idstringrequired

The OAuth client ID.

Example:"fulfilment-connector"
client_secretstringrequired

The OAuth client secret. Stored encrypted and never returned by any endpoint.

Example:"8f6e2b1a9c4d7e05"
scopestring

An optional scope to request from the token endpoint.

Example:"orders.read"
audiencestring

An optional audience to request from the token endpoint.

Example:"https://api.fulfilment.example.com"
request_formatstring

The format the client credentials are sent in when requesting a token. Defaults to json.

Enum:"json""form_encoded"
Example:"json"
{
  "token_url": "https://auth.fulfilment.example.com/oauth/token",
  "client_id": "fulfilment-connector",
  "client_secret": "8f6e2b1a9c4d7e05",
  "scope": "orders.read",
  "audience": "https://api.fulfilment.example.com",
  "request_format": "json"
}