Skip to main content


The configuration of a customer card that defines four important things:

  • The title of the card
  • The key of the card, which will be used in the request payload to the API URL
  • The order in which the cards should appear
  • Which API the card should be loaded from (and the required authentication headers)

Configs that have the same API URL and API Headers will be loaded in batch. API header names are treated case insensitively.

A maximum of 25 customer cards can be configured.

type CustomerCardConfig {
id: ID!
order: Int!
title: String!
key: String!
defaultTimeToLiveSeconds: Int!
apiUrl: String!
apiHeaders: [CustomerCardConfigApiHeader!]!
isEnabled: Boolean!
createdAt: DateTime!
createdBy: InternalActor!
updatedAt: DateTime!
updatedBy: InternalActor!

Fields ● ID! non-null scalar

The ID of the customer card config.

CustomerCardConfig.order ● Int! non-null scalar

The order in which this customer card config should be shown.

Duplicate order numbers are allowed, in case the order is the same they will be sorted based on id. The minimum is 0 and the maximum is 100000.

CustomerCardConfig.title ● String! non-null scalar

The title of the card (max length: 500 characters).

CustomerCardConfig.key ● String! non-null scalar

The key of the card (must be unique in a workspace, max length: 500 characters, must match regex: [a-zA-Z0-9_-]+).

CustomerCardConfig.defaultTimeToLiveSeconds ● Int! non-null scalar

The default time the card should be cached for if no TTL is provided in the card response. (minimum: 15 seconds, maximum: 1 year or 31,536,000 seconds).

CustomerCardConfig.apiUrl ● String! non-null scalar

The URL from which this card should be loaded (must start with https:// and be a valid URL, max length: 600 characters). Requires the customerCardConfigApiDetails:read permission.

CustomerCardConfig.apiHeaders ● [CustomerCardConfigApiHeader!]! non-null object

An array of headers name-value pairs (maximum length of array: 20). Requires the customerCardConfigApiDetails:read permission.

CustomerCardConfig.isEnabled ● Boolean! non-null scalar

Indicates if the customer card is enabled or not. Disabled customer card configs are not loaded or displayed for customers.

CustomerCardConfig.createdAt ● DateTime! non-null object

CustomerCardConfig.createdBy ● InternalActor! non-null union

CustomerCardConfig.updatedAt ● DateTime! non-null object

CustomerCardConfig.updatedBy ● InternalActor! non-null union

Returned by

customerCardConfig query ● customerCardConfigs query

Member of

CreateCustomerCardConfigOutput object ● CustomerCardInstance interface ● CustomerCardInstanceError object ● CustomerCardInstanceLoaded object ● CustomerCardInstanceLoading object ● ReorderCustomerCardConfigsOutput object ● UpdateCustomerCardConfigOutput object