CrmActionLink - HubSpot docs

The CrmActionLink component renders a clickable link that can execute a built-in set of CRM actions. This type of component is useful for enabling your extension to interact with other CRM entities, such as records and engagements. To learn more about how CRM action components work together, check out the CRM action components overview.

import { CrmActionLink } from "@hubspot/ui-extensions/crm";

const dealContext = {
  objectTypeId: "0-3",
  objectId: 14795354663,
};

hubspot.extend(({ context, runServerlessFunction, actions }) => {
  return (
    <>
      <CrmActionLink actionType="ADD_NOTE" actionContext={dealContext}>
        Add a note about this deal to the record
      </CrmActionLink>
    </>
  );
});

Props

Prop	Type	Description
`actionContext`	Object	An object containing the CRM object and record context for performing the action. See list of available actions for required context values.
`actionType`	String	The type of action to perform. See list of available actions for more information.
`onClick`	`() => void`	A function that will be invoked when the button is clicked. It receives no arguments and its return value is ignored.
`onError`	`(errors: string[]) => void`	An optional callback that will pass any error messages that were generated. Common errors include missing required context values or the user not having sufficient permissions to perform an action.
`variant`	`'primary'` (default) \| `'light'` \| `'dark'` \| `'destructive'`	The color variation of the link. See the variants section for more information.

Variants

Using the variant prop, you can control the color of the link.

'primary': the default blue (#0091ae).

'light': a white link that turns to a lighter shade of blue on hover (#7fd1de).

'dark': a darker shade of blue (#33475b).

'destructive': a red link (#f2545b).

​Props

​Variants

​Related components

Props

Variants

Related components