Skip to main content
Example workflow button
A workflow button has the following properties:
  • workflowButtonLabel: the text of the button
  • workflowButtonWorkflowIdentifier: an object containing either:
    • workflowId: the ID of the workflow to trigger
When clicked, the button will trigger the specified workflow in the context of the current thread. The button shows a loading state while the workflow is being triggered and displays a tooltip with the latest execution status, including when it was run and how long it took. For example: 
import { uiComponent } from '@team-plain/typescript-sdk';

uiComponent.workflowButton({
  label: 'Run sync',
  workflowIdentifier: {
    workflowId: 'wf_01ABC123DEF456',
  },
});