CustomerCardConfig
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.
CustomerCardConfigFields
The ID of the customer card config.
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.
The title of the card (max length: 500 characters).
The key of the card, sent to your API in the request payload to identify which card is being requested (must be unique in a workspace, max length: 500 characters, must match regex: [a-zA-Z0-9_-]+).
How long (in seconds) to cache a loaded card when your API response does not include its own TTL. Your API can override this per-response. (minimum: 15 seconds, maximum: 1 year or 31,536,000 seconds).
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.
An array of headers name-value pairs (maximum length of array: 20). Requires the customerCardConfigApiDetails:read permission.
Indicates if the customer card is enabled or not. Disabled customer card configs are not loaded or displayed for customers.