Class IntegratorCardPayloadResponse

The card details payload, sent to HubSpot by an app in response to a data fetch request when a user visits a CRM record page.

Constructors

constructor

Properties

allItemsLinkUrl? cardLabel? responseVersion? sections? topLevelActions? totalCount attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

OptionalallItemsLinkUrl

allItemsLinkUrl?: string

URL to a page the integrator has built that displays all details for this card. This URL will be displayed to users under a See more [x] link if there are more than five items in your response, where [x] is the value of itemLabel.

OptionalcardLabel

cardLabel?: string

The label to be used for the allItemsLinkUrl link (e.g. 'See more tickets'). If not provided, this falls back to the card's title.

OptionalresponseVersion

responseVersion?: IntegratorCardPayloadResponseResponseVersionEnum

Optionalsections

sections?: IntegratorObjectResult[]

A list of up to five valid card sub categories.

OptionaltopLevelActions

topLevelActions?: TopLevelActions

totalCount

totalCount: number

The total number of card properties that will be sent in this response.

Static ReadonlyattributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Static Readonlydiscriminator

discriminator: undefined | string = undefined

Static Readonlymapping

mapping: undefined | {
    [index: string]: string;
} = undefined

Methods

StaticgetAttributeTypeMap

Settings

Member Visibility

On This Page

Constructors
Properties
Methods