Workflow-backed Buttons

Brezel buttons are UI entry points for workflows. They are useful for record-level actions such as exporting a PDF, sending a notification, generating a document, or starting a review flow from a module detail or index view.

Detail view button

Place standalone action buttons with the buttons layout component. Do not use a singular button component.

{
  "type": "buttons",
  "options": {
    "justify_content": "flex-end",
    "buttons": [
      {
        "identifier": "exportPdf",
        "icon": "mdi:file-pdf-outline",
        "type": "primary",
        "event": {
          "action": "workflow",
          "module": "example_module",
          "event": "onExportPdf"
        }
      }
    ]
  }
}

The referenced workflow should define an event/webhook entry for the same module and event identifier.

Automatic button bar

An event/webhook can also add itself to the default button bar by setting show_in_button_bar when that convention is used by the target system.

{
  "name": "onExportPdf",
  "type": "event/webhook",
  "options": {
    "module": "example_module",
    "title": "Als PDF exportieren",
    "show_in_button_bar": true
  }
}

Implementation checklist

• Inspect the current layout first and preserve its structure.
• Add the buttons component in the existing affix or top row when the action should feel global for the record.
• Create or update the workflow in the same draft.
• Refresh the preview after both layout and workflow files are written.
• Treat the visual button and the workflow endpoint as one feature: the button should point to a workflow event that exists.