Build an integration

Canvas objects


A button component is used to take an action by clicking a button. This can either:

  • Trigger a submit request to be sent
  • Open a link in a new page


Parameter Possible Values Required Description
type button Yes The type of component you are rendering.
id Any string Yes A unique identifier for the component.
label Any string Yes The text that will be rendered inside the button.
action Action object Yes This can be a Submit Action or URL Action.
style primary secondary link No Styles the button. Default is primary.
disabled false true No Styles the button and prevents the action. Default is false.