Adds a clickable button column. The button triggers a POST request (POST /action/{activityKey}) with the row data.

Tip

The API response is a JSON object with status (success or failure), successText (result message key), and targetUrl (redirect URL, nullable).

  • If targetUrl is set, open it in a new tab.
  • If the action succeeds and no targetUrl is provided, refresh the table.
  • If the action fails, the pipeline error message is shown in the notification toast; a generic error is used as fallback if no message is returned.

Minimal JSON

{
    "type": "customActionButton",
    "activityKey": "",
    "pipelineKey": ""
}
{
    "type": "customActionButton",
    "activityKey": "my_action_set_confirmed",
    "pipelineKey": "my_pipeline",
    "disabledColumnKey": "Confirm_Blocked",
    "tableIdsToRefresh": ["my_action_summary"],
    "text": "template.my_action.button.confirm",
    "tooltipKey": "template.my_action.tooltip.confirm"
}

Nested properties

PropertyDescriptionValuesMandatory
activityKeyKey for the triggered action. For more information, see activities.stringYes
pipelineKeyPipeline key. For more information, see pipeline.stringYes
disabledColumnKeyDisables the button for rows where this SQL view column returns true.stringNo
tableIdsToRefreshList of table IDs to refresh after the action completes.arrayNo
textTranslation key for the button label.stringNo
tooltipKeyTranslation key of the tooltip that appears when hovering over the property. Define in translations to specify how the text is displayed in the UI.stringNo