The fields accepted when storing a new third-party credential. Set token_type to text (the default) to store a plain credential value, or to oauth to have Intercom obtain and manage an access token via the OAuth client-credentials grant.
A name for the credential, so a teammate can identify it later.
The credential value. Required when token_type is text. Must be omitted when token_type is oauth. Stored encrypted and never returned by any endpoint.
The request header the credential is sent in. Required when token_type is text. Must be omitted when token_type is oauth, where it is fixed to Authorization.
An optional prefix placed before the credential value in the header, for example Bearer. Must be omitted when token_type is oauth, where it is fixed to Bearer.
An optional description of what the credential is used for.
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.
{ "name": "Fulfilment API key", "token_type": "text", "token_value": "sk_live_9f3c2a7b41e8", "request_header_key": "Authorization", "token_prefix": "Bearer", "description": "Used by the order status connector", "oauth_configuration": { "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" } }