Skip to content

Auth Tokens

Read and write the third-party credentials stored in your workspace, so you can find the id of the credential a data connector should authenticate with, and store a new one without leaving your integration. These endpoints are part of the Preview API version. Reading requires an OAuth token with the read_auth_tokens scope; creating and updating require the write_auth_tokens scope and an access token associated with a teammate. You can create a text credential to send yourself, or an oauth credential whose access token Intercom obtains and refreshes automatically via the client-credentials grant. Only credentials with a token_type of text can be updated. No endpoint ever returns a credential value, client secret, refresh configuration, or OAuth configuration.

Auth Token

Metadata for a stored third-party credential that data connectors use to authenticate outbound requests. Only metadata is returned — the credential value itself, and its refresh and OAuth configuration, are never exposed.

typestring

The type of object - auth_token.

Value:"auth_token"
Example:"auth_token"
idstring

The unique identifier for the auth token.

Example:"12345"
namestring or null

The name given to the credential when it was created.

Example:"Fulfilment API key"
descriptionstring or null

An optional description of what the credential is used for.

Example:"Used by the order status connector"
token_typestring or null

How the credential is presented to the external API, for example as a header value or an HMAC signature.

Example:"text"
request_header_keystring or null

The request header the credential is sent in.

Example:"Authorization"
token_prefixstring or null

The prefix placed before the credential value in the header, for example Bearer.

Example:"Bearer"
domainstring or null

The domain the credential is scoped to, if one was set.

Example:"api.fulfilment.example.com"
created_atinteger or null

The time the credential was created as a Unix timestamp.

Example:1763199000
updated_atinteger or null

The time the credential was last updated as a Unix timestamp.

Example:1768918935
{ "type": "auth_token", "id": "12345", "name": "Fulfilment API key", "description": "Used by the order status connector", "token_type": "text", "request_header_key": "Authorization", "token_prefix": "Bearer", "domain": "api.fulfilment.example.com", "created_at": 1763199000, "updated_at": 1768918935 }